Tree - rpms/openldap - src.fedoraproject.org

mhonek / rpms / openldap

Forked from rpms/openldap 3 years ago

Blame guide.html

Blob History Raw

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<HTML>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

     Ian Clatworthy (ianc@mincom.com). SDF is freely

cvsdist

7a16c4a

     available from http://www.mincom.com/mtr/sdf. -->

cvsdist

7a16c4a

cvsdist

7a16c4a

<HEAD>

cvsdist

7a16c4a

<TITLE>OpenLDAP 2.0 Administrator's Guide</TITLE>

cvsdist

7a16c4a

</HEAD>

cvsdist

7a16c4a

<BODY>

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Home | Catalog

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

OpenLDAP 2.0 Administrator's Guide

cvsdist

7a16c4a

<ADDRESS CLASS="doc-author">The OpenLDAP Project <http://www.openldap.org/></ADDRESS>

cvsdist

7a16c4a

<ADDRESS CLASS="doc-modified">15 September 2000</ADDRESS>

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Table of Contents

cvsdist

7a16c4a

cvsdist

7a16c4a

Preface

cvsdist

7a16c4a

cvsdist

7a16c4a

1. Introduction to OpenLDAP Directory Services

cvsdist

7a16c4a

1.1. What is a directory service?

cvsdist

7a16c4a

cvsdist

7a16c4a

1.2. What is LDAP?

cvsdist

7a16c4a

cvsdist

7a16c4a

1.3. How does LDAP work?

cvsdist

7a16c4a

cvsdist

7a16c4a

1.4. What is slapd and what can it do?

cvsdist

7a16c4a

cvsdist

7a16c4a

1.5. What about X.500?

cvsdist

7a16c4a

cvsdist

7a16c4a

1.6. What is slurpd and what can it do?

cvsdist

7a16c4a

cvsdist

7a16c4a

2. A Quick-Start Guide

cvsdist

7a16c4a

cvsdist

7a16c4a

3. The Big Picture - Configuration Choices

cvsdist

7a16c4a

3.1. Local Directory Service

cvsdist

7a16c4a

cvsdist

7a16c4a

3.2. Local Directory Service with Referrals

cvsdist

7a16c4a

cvsdist

7a16c4a

3.3. Replicated Directory Service

cvsdist

7a16c4a

cvsdist

7a16c4a

3.4. Distributed Local Directory Service

cvsdist

7a16c4a

cvsdist

7a16c4a

4. Building and Installing OpenLDAP Software

cvsdist

7a16c4a

4.1. Obtaining and Extracting the Software

cvsdist

7a16c4a

cvsdist

7a16c4a

4.2. Prerequisite software

cvsdist

7a16c4a

cvsdist

7a16c4a

4.3. Running configure

cvsdist

7a16c4a

cvsdist

7a16c4a

4.4. Building the Software

cvsdist

7a16c4a

cvsdist

7a16c4a

4.5. Testing the Software

cvsdist

7a16c4a

cvsdist

7a16c4a

4.6. Installing the Software

cvsdist

7a16c4a

cvsdist

7a16c4a

5. The slapd Configuration File

cvsdist

7a16c4a

5.1. Configuration File Format

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2. Configuration File Directives

cvsdist

7a16c4a

cvsdist

7a16c4a

5.3. Access Control

cvsdist

7a16c4a

cvsdist

7a16c4a

5.4. Configuration File Example

cvsdist

7a16c4a

cvsdist

7a16c4a

6. Running slapd

cvsdist

7a16c4a

6.1. Command-Line Options

cvsdist

7a16c4a

cvsdist

7a16c4a

6.2. Starting slapd

cvsdist

7a16c4a

cvsdist

7a16c4a

6.3. Stopping slapd

cvsdist

7a16c4a

cvsdist

7a16c4a

7. Database Creation and Maintenance Tools

cvsdist

7a16c4a

7.1. Creating a database over LDAP

cvsdist

7a16c4a

cvsdist

7a16c4a

7.2. Creating a database off-line

cvsdist

7a16c4a

cvsdist

7a16c4a

7.3. The LDIF text entry format

cvsdist

7a16c4a

cvsdist

7a16c4a

8. Schema Specification

cvsdist

7a16c4a

8.1. Distributed Schema Files

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2. Extending Schema

cvsdist

7a16c4a

cvsdist

7a16c4a

9. Constructing a Distributed Directory Service

cvsdist

7a16c4a

9.1. Subordinate Knowledge Information

cvsdist

7a16c4a

cvsdist

7a16c4a

9.2. Superior Knowledge Information

cvsdist

7a16c4a

cvsdist

7a16c4a

9.3. The ManageDsaIT Control

cvsdist

7a16c4a

cvsdist

7a16c4a

10. Replication with slurpd

cvsdist

7a16c4a

10.1. Overview

cvsdist

7a16c4a

cvsdist

7a16c4a

10.2. Replication Logs

cvsdist

7a16c4a

cvsdist

7a16c4a

10.3. Command-Line Options

cvsdist

7a16c4a

cvsdist

7a16c4a

10.4. Configuring slurpd and a slave slapd instance

cvsdist

7a16c4a

cvsdist

7a16c4a

10.5. Advanced slurpd Operation

cvsdist

7a16c4a

cvsdist

7a16c4a

A. Generic configure Instructions

cvsdist

7a16c4a

cvsdist

7a16c4a

B. OpenLDAP Software Copyright Notices

cvsdist

7a16c4a

B.1. OpenLDAP Copyright Notice

cvsdist

7a16c4a

cvsdist

7a16c4a

B.2. University of Michigan Copyright Notice

cvsdist

7a16c4a

cvsdist

7a16c4a

C. The OpenLDAP Public License

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Preface

cvsdist

7a16c4a

Copyright

cvsdist

7a16c4a

Copyright 1998-2000, The OpenLDAP Foundation, All Rights Reserved.

cvsdist

7a16c4a

Copyright 1992-1996, Regents of the University of Michigan, All Rights Reserved.

cvsdist

7a16c4a

Scope of this Document

cvsdist

7a16c4a

This document provides a guide for installing OpenLDAP 2.0 Software on <TERM>UNIX</TERM> (and UNIX-like) systems.  The document is aimed at experienced system administrators but who may not have prior experience operating <TERM>LDAP</TERM>-based directory software.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>OpenLDAP Resources</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Resource

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

URL

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Document Catalog

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/doc/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Frequently Asked Questions

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/faq/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Issue Tracking System

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/its/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Mailing Lists

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/lists/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Software Pages

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/software/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Support Pages

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/support/

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Acknowledgments

cvsdist

7a16c4a

The OpenLDAP Project is comprised of a team of volunteers.  This document would not be possible without their contribution of time and energy.

cvsdist

7a16c4a

The OpenLDAP Project would also like to thank the University of Michigan LDAP for building the foundation of LDAP software and information to which OpenLDAP Software is built upon.

cvsdist

7a16c4a

Amendments

cvsdist

7a16c4a

Suggested enhancements and corrections to this document should be submitted using the OpenLDAP <TERM>Issue Tracking System</TERM> (http://www.openldap.org/its/).

cvsdist

7a16c4a

About this document

cvsdist

7a16c4a

This document was produced using the Simple Document Format (http://www.mincom.com/mtr/sdf/) documentation system developed by Ian Clatworthy.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

1. Introduction to OpenLDAP Directory Services

cvsdist

7a16c4a

This document describes how to build, configure, and operate OpenLDAP software to provide directory services.  This includes details on how to configure and run the stand-alone <TERM>LDAP</TERM> daemon, slapd(8) and the stand-alone LDAP update replication daemon, slurpd(8). It is intended for newcomers and experienced administrators alike. This section provides a basic introduction to directory services and, in particular, the directory services provided by slapd(8).

cvsdist

7a16c4a

1.1. What is a directory service?

cvsdist

7a16c4a

A directory is specialized database optimized for reading, browsing and searching.  Directories tend to contain descriptive, attribute-based information and support sophisticated filtering capabilities.  Directories generally do not support complicated transaction or roll-back schemes found in database management systems designed for handling high-volume complex updates.  Directory updates are typically simple all-or-nothing changes, if they are allowed at all.  Directories are tuned to give quick-response to high-volume lookup or search operations. They may have the ability to replicate information widely in order to increase availability and reliability, while reducing response time.  When directory information is replicated, temporary inconsistencies between the replicas may be okay, as long as they get in sync eventually.

cvsdist

7a16c4a

There are many different ways to provide a directory service. Different methods allow different kinds of information to be stored in the directory, place different requirements on how that information can be referenced, queried and updated, how it is protected from unauthorized access, etc. Some directory services are local, providing service to a restricted context (e.g., the finger service on a single machine). Other services are global, providing service to a much broader context (e.g., the entire Internet). Global services are usually distributed, meaning that the data they contain is spread across many machines, all of which cooperate to provide the directory service. Typically a global service defines a uniform namespace which gives the same view of the data no matter where you are in relation to the data itself.  The Internet <TERM>Domain Name System</TERM> is an example of a globally distributed directory service.

cvsdist

7a16c4a

1.2. What is LDAP?

cvsdist

7a16c4a

slapd's model for directory service is based on a global directory model called <TERM>LDAP</TERM>.  LDAP stands for <TERM>Lightweight Directory Access Protocol</TERM>. LDAP is a directory access protocol that runs over <TERM>TCP</TERM>/<TERM>IP</TERM>. The nitty-gritty details of LDAP are defined in RFC2251 "The Lightweight Directory Access Protocol (v3)." This section gives an overview of LDAP from a user's perspective.

cvsdist

7a16c4a

What kind of information can be stored in the directory? The LDAP information model is based on entries. An entry is a collection of attributes that has a globally-unique <TERM>Distinguished Name</TERM> (DN). The DN is used to refer to the entry unambiguously. Each of the entry's attributes has a type and one or more values. The types are typically mnemonic strings, like "<TT>cn</TT>" for common name, or "<TT>mail</TT>" for email address. The syntax of values depend on the attribute type is.  For example, <TT>cn</TT> attribute might be the value <TT>Babs Jensen</TT>.  A <TT>mail</TT> attribute might contain the value "<TT>babs@example.com</TT>". A <TT>jpegPhoto</TT> attribute would contain a photograph in the JPEG (binary) format.

cvsdist

7a16c4a

How is the information arranged? In LDAP, directory entries are arranged in a hierarchical tree-like structure.  Traditionally, this structure reflected the geographic and/or organizational boundaries.  Entries representing countries appeared at the top of the tree. Below them are entries representing states and national organizations. Below them might be entries representing organizational units, people, printers, documents, or just about anything else you can think of.  Figure 1.1 shows an example LDAP directory tree using traditional naming.

cvsdist

7a16c4a

<CENTER></CENTER>

cvsdist

7a16c4a

Figure 1.1: LDAP directory tree (traditional naming)

cvsdist

7a16c4a

The tree may also be arranged based upon Internet domain names.  This naming approach is becoming increasing popular as it allows for directory services to be locating using the <TERM>Domain Name System</TERM>. Figure 1.2 shows an example LDAP directory tree using domain-based naming.

cvsdist

7a16c4a

<CENTER></CENTER>

cvsdist

7a16c4a

Figure 1.2: LDAP directory tree (Internet naming)

cvsdist

7a16c4a

In addition, LDAP allows you to control which attributes are required and allowed in an entry through the use of a special attribute called <TT>objectClass</TT>.  The values of the <TT>objectClass</TT> attribute determine the schema rules the entry must obey.

cvsdist

7a16c4a

How is the information referenced? An entry is referenced by its distinguished name, which is constructed by taking the name of the entry itself (called the <TERM>Relative Distinguished Name</TERM> or RDN) and concatenating the names of its ancestor entries. For example, the entry for Barbara Jensen in the Internet naming example above has an RDN of <TT>uid=babs</TT> and a DN of <TT>uid=babs,ou=People,dc=example,dc=com</TT>". The full DN format is described in RFC2253, "Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names."

cvsdist

7a16c4a

How is the information accessed? LDAP defines operations for interrogating and updating the directory. Operations are provided for adding and deleting an entry from the directory, changing an existing entry, and changing the name of an entry. Most of the time, though, LDAP is used to search for information in the directory. The LDAP search operation allows some portion of the directory to be searched for entries that match some criteria specified by a search filter. Information can be requested from each entry that matches the criteria.

cvsdist

7a16c4a

For example, you might want to search the entire directory subtree at and below <TT>dc=example,dc=com</TT> for people with the name <TT>Barbara Jensen</TT>, retrieving the email address of each entry found. LDAP lets you do this easily.  Or you might want to search the entries directly below the <TT>st=California,c=US</TT> entry for organizations with the string <TT>Acme</TT> in their name, and that have a fax number. LDAP lets you do this too. The next section describes in more detail what you can do with LDAP and how it might be useful to you.

cvsdist

7a16c4a

How is the information protected from unauthorized access? Some directory services provide no protection, allowing anyone to see the information. LDAP provides a mechanisms for a client to authenticate, or prove its identity to a directory server, paving the way for rich access control to protect the information the server contains.  LDAP also supports privacy and integrity security services.

cvsdist

7a16c4a

1.3. How does LDAP work?

cvsdist

7a16c4a

LDAP directory service is based on a client-server model. One or more LDAP servers contain the data making up the LDAP directory tree. An LDAP client connects to an LDAP server and asks it a question. The server responds with the answer and/or with a pointer to where the client can get additional information (typically, another LDAP server). No matter which LDAP server a client connects to, it sees the same view of the directory; a name presented to one LDAP server references the same entry it would at another LDAP server. This is an important feature of a global directory service, like LDAP.

cvsdist

7a16c4a

1.4. What is slapd and what can it do?

cvsdist

7a16c4a

slapd is an LDAP directory server that runs on many different platforms. You can use it to provide a directory service of your very own. Your directory can contain pretty much anything you want to put in it. You can connect it to the global LDAP directory service, or run a service all by yourself. Some of slapd's more interesting features and capabilities include:

cvsdist

7a16c4a

LDAPv2 and LDAPv3: slapd supports both version 2 and 3 of the <TERM>Lightweight Directory Access Protocol</TERM>.  slapd provides support for the latest features while maintaining interoperability with existing clients.  slapd supports both IPv4 and IPv6.

cvsdist

7a16c4a

<TERM>Simple Authentication and Security Layer</TERM>: slapd supports strong authentication services through the use of SASL.  slapd's SASL implementation utilizes Cyrus SASL software which supports a number of mechanisms including DIGEST-MD5, EXTERNAL, and GSSAPI.

cvsdist

7a16c4a

<TERM>Transport Layer Security</TERM>: slapd provides privacy and integrity protections through the use of TLS (or SSL).  slapd's TLS implementation utilizes OpenSSL software.

cvsdist

7a16c4a

Access control: slapd provides a rich and powerful access control facility, allowing you to control access to the information in your database(s). You can control access to entries based on LDAP authorization information, <TERM>IP</TERM> address, domain name and other criteria. slapd supports both static and dynamic access control information.

cvsdist

7a16c4a

Internationalization: slapd supports Unicode and language tags.

cvsdist

7a16c4a

Choice of databases: slapd comes with a variety of different backend databases you can choose from. They include <TERM>LDBM</TERM>, a high-performance disk-based embedded database; SHELL, a database interface to arbitrary shell scripts; and PASSWD, a simple password file database.  LDBM utilizes either BerkeleyDB or GDBM.

cvsdist

7a16c4a

Multiple database instances: slapd can be configured to serve multiple databases at the same time. This means that a single slapd server can respond to requests for many logically different portions of the LDAP tree, using the same or different backend databases.

cvsdist

7a16c4a

Generic modules API: If you require even more customization, slapd lets you write your own modules easily. slapd consists of two distinct parts: a front end that handles protocol communication with LDAP clients; and modules which handle specific tasks such as database operations. Because these two pieces communicate via a well-defined <TERM>C</TERM> <TERM>API</TERM>, you can write your own customized modules which extend slapd in numerous ways.  Also, a number of programmable database modules are provided.  These allow you to expose external data sources to slapd using popular programming languages (Perl, Shell, SQL, and TCL).

cvsdist

7a16c4a

Threads: slapd is threaded for high performance. A single multi-threaded slapd process handles all incoming requests, reducing the amount of system overhead required.

cvsdist

7a16c4a

Replication: slapd can be configured to maintain replica copies of its database. This single-master/multiple-slave replication scheme is vital in high-volume environments where a single slapd just doesn't provide the necessary availability or reliability.  slapd also includes experimental support for multi-master replication.

cvsdist

7a16c4a

Configuration: slapd is highly configurable through a single configuration file which allows you to change just about everything you'd ever want to change.  Configuration options have reasonable defaults, making your job much easier.

cvsdist

7a16c4a

slapd also has its limitations, of course. The main LDBM database backend does not handle range queries or negation queries very well. These features and more will be coming in a future release.

cvsdist

7a16c4a

1.5. What about X.500?

cvsdist

7a16c4a

Technically, LDAP is a directory access protocol to an <TERM>X.500</TERM> directory service, the <TERM>OSI</TERM> directory service.  Initial LDAP servers were gateways between LDAP and the X.500 <TERM>Directory Access Protocol</TERM> (<TERM>DAP</TERM>).  DAP is a heavyweight protocol that operates over a full OSI protocol stack and requires a significant amount of computing resources.  LDAP is designed to operate over <TERM>TCP</TERM>/<TERM>IP</TERM> and provides most of the functionality of DAP at a much lower cost.

cvsdist

7a16c4a

This use of LDAP makes it easy to access the X.500 directory, but still requires a full X.500 service to make data available to the many LDAP clients being developed. As with full X.500 DAP clients, a full X.500 DAP server is no small piece of software to operate.

cvsdist

7a16c4a

The stand-alone LDAP daemon, or slapd(8), is meant to remove much of the burden from the server side just as LDAP itself removed much of the burden from clients. If you are already running a X.500 DAP service and you want to continue to do so, you can probably stop reading this guide, which is all about running LDAP via slapd, without running X.500 DAP. If you are not running X.500 DAP, want to stop running X.500 DAP, or have no immediate plans to run X.500 DAP, read on.

cvsdist

7a16c4a

It is possible to replicate data from an LDAP directory server to a X.500 DAP <TERM>DSA</TERM>.  This requires an LDAP/DAP gateway.  OpenLDAP does not provide such a gateway, but our replication daemon can be used to replicate to such a gateway. See the Replication with slurpd chapter of this document for information regarding replication.

cvsdist

7a16c4a

1.6. What is slurpd and what can it do?

cvsdist

7a16c4a

slurpd(8) is a daemon that helps slapd provide replicated service. It is responsible for distributing changes made to the master slapd database out to the various slapd replicas. It frees slapd from having to worry that some replicas might be down or unreachable when a change comes through; slurpd handles retrying failed requests automatically. slapd and slurpd communicate through a simple text file that is used to log changes.

cvsdist

7a16c4a

See the Replication with slurpd chapter for information about how to configure and run slurpd(8).

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

2. A Quick-Start Guide

cvsdist

7a16c4a

The following is a quick start guide to OpenLDAP 2.0 software, including the stand-alone LDAP daemon, slapd(8).

cvsdist

7a16c4a

It is meant to step you through the basic steps needed to install and configure OpenLDAP software. It should be used in conjunction with the other chapters of this document, manual pages, and other materials provided with the distribution (e.g. the <TT>INSTALL</TT> document) or on the OpenLDAP web site (in particular, the OpenLDAP Software FAQ).

cvsdist

7a16c4a

If you intend to run OpenLDAP seriously, you should review the all of this document before attempt to install the software.

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: This quick start guide does not use strong authentication nor any privacy and integrity protection services.  These services are described in other chapters of the OpenLDAP Administrator's Guide.

cvsdist

cvsdist

cvsdist

cvsdist

Get the software

cvsdist

7a16c4a

cvsdist

7a16c4a

You can obtain a copy of the software by following the instructions on the OpenLDAP download page (http://www.openldap.org/software/download/). It is recommended that new users start with the (latest) release.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Unpack the distribution

cvsdist

7a16c4a

cvsdist

7a16c4a

Pick a directory for the LDAP source to live under, change directory to there, and unpack the distribution using the following commands:

cvsdist

7a16c4a

<TT>gunzip -c openldap-VERSION.tgz | tar xvfB -</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

then relocate yourself into the distribution directory:

cvsdist

7a16c4a

<TT>cd openldap-VERSION</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

You'll have to replace <TT>VERSION</TT> with the version name of the release.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Review documentation

cvsdist

7a16c4a

cvsdist

7a16c4a

You should now review the <TT>COPYRIGHT</TT>, <TT>LICENSE</TT>, <TT>README</TT> and <TT>INSTALL</TT> documents provided with the distribution. The <TT>COPYRIGHT</TT> and <TT>LICENSE</TT> provide information on acceptable use, copying, and limitation of warranty of OpenLDAP software.

cvsdist

cvsdist

cvsdist

cvsdist

You should also review other chapters of this document. In particular, the Building and Installing OpenLDAP Software chapter of this document provides detailed information on prerequisite software and installation procedures.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Run <TT>configure</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

You will need to run the provided <TT>configure</TT> script to configure to the distribution for building on your system.  The <TT>configure</TT> script accepts many command line options that enable or disable optional software features.  Usually the defaults are okay, but you may want to change them.  To get a complete list of options that <TT>configure</TT> accepts, use the <TT>--help</TT> option:

cvsdist

7a16c4a

<TT>./configure --help</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

However, given that you using this guide, we'll assume you'll are brave enough to just let <TT>configure</TT> to determine what's best:

cvsdist

7a16c4a

<TT>./configure</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Assuming <TT>configure</TT> doesn't dislike your system, you can proceed with building the software.  If <TT>configure</TT> did complain, well, you'll likely need to go to the FAQ Installation Section (http://www.openldap.org/faq/ and/or actually read the Building and Installing OpenLDAP Software chapter of this document.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Build the software.

cvsdist

7a16c4a

cvsdist

7a16c4a

The next step is to build the software.  This step has two parts, first we construct dependencies and then we compile the software:

cvsdist

7a16c4a

<TT>make depend</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>make</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Both makes should complete without error.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Test the build.

cvsdist

7a16c4a

cvsdist

7a16c4a

To ensure a correct build, you should run the test suite (it only takes a few minutes):

cvsdist

7a16c4a

<TT>make test</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Tests which apply to your configuration will run and they should pass.  Some tests, such as the replication test, may be skipped.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Install the software.

cvsdist

7a16c4a

cvsdist

7a16c4a

You are now ready to install the software, this usually requires super-user privledges:

cvsdist

7a16c4a

<TT>su root -c 'make install'</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Everything should now be installed under <TT>/usr/local</TT> (or whatever installation prefix was used by <TT>configure</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Edit the configuration file.

cvsdist

7a16c4a

cvsdist

7a16c4a

Use your favorite editor to edit the provided slapd.conf(5) example (usually installed as <TT>/usr/local/etc/openldap/slapd.conf</TT>) to contain an LDBM database definition of the form:

cvsdist

7a16c4a

<TT>database        ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>suffix          "dc=<MY-DOMAIN>,dc=<COM>"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootdn          "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootpw          secret</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>directory       /usr/local/var/openldap-ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Be sure to replace <TT><MY-DOMAIN></TT> and <TT><COM></TT> with the appropriate domain components of your domain name.  For example, for <TT>example.com</TT>, use:

cvsdist

7a16c4a

<TT>database        ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>suffix          "dc=example,dc=com"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootdn          "cn=Manager,dc=example,dc=com"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootpw          secret</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>directory       /usr/local/var/openldap-ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

If your domain contains additional components, such as <TT>eng.uni.edu.eu</TT>, use:

cvsdist

7a16c4a

<TT>database        ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>suffix          "dc=eng,dc=uni,dc=edu,dc=eu"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootdn          "cn=Manager,dc=eng,dc=uni,dc=edu,dc=eu"</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>rootpw          secret</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>directory       /usr/local/var/openldap-ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Details regarding configuring slapd(8) can be found in the slapd.conf(5) manual page and the The slapd Configuration File chapter of this document.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Start SLAPD.

cvsdist

7a16c4a

cvsdist

7a16c4a

You are now ready to start the stand-alone LDAP server, slapd(8), by running the command:

cvsdist

7a16c4a

<TT>su root -c /usr/local/libexec/slapd</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

To check to see if the server is running and configured correctly, you can run a search against it with ldapsearch(1).  By default, ldapsearch is installed as <TT>/usr/local/bin/ldapsearch</TT>:

cvsdist

7a16c4a

<TT>ldapsearch -x -b '' -s base '(objectclass=*)' namingContexts</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Note the use of single quotes around command parameters to prevent special characters from being interpreted by the shell.  This should return:

cvsdist

7a16c4a

<TT>dn:</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>namingContexts: dc=example,dc=com</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Details regarding running slapd(8) can be found in the slapd(8) manual page and the Running slapd chapter of this document.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Add initial entries to your directory.

cvsdist

7a16c4a

cvsdist

7a16c4a

You can use ldapadd(1) to add entries to your LDAP directory. ldapadd expects input in LDIF form. We'll do it in two steps:

cvsdist

7a16c4a

create an LDIF file

cvsdist

7a16c4a

run ldapadd

cvsdist

7a16c4a

cvsdist

7a16c4a

Use your favorite editor and create an LDIF file that contains:

cvsdist

7a16c4a

<TT>dn: dc=<MY-DOMAIN>,dc=<COM></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: dcObject</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: organization</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>o: <MY ORGANIZATION></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>dc: <MY-DOMAIN></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>dn: cn=Manager,dc=<MY-DOMAIN>,dc=<COM></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: organizationalRole</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>cn: Manager</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Be sure to replace <MY-DOMAIN> and <COM> with the appropriate domain components of your domain name.  <MY ORGANIZATION> should be replaced with the name of your organization.  If you cut and paste, be sure to trim any leading and trailing whitespace from the example.

cvsdist

7a16c4a

<TT>dn: dc=example,dc=com</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: dcObject</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: organization</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>o: Example Company</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>dc: example</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>dn: cn=Manager,dc=example,dc=com</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>objectclass: organizationalRole</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>cn: Manager</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Now, you may run ldapadd(1) to insert these entries into your directory.

cvsdist

7a16c4a

<TT>ldapadd -x -D "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>" -W -f example.ldif</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Be sure to replace <TT><MY-DOMAIN></TT> and <TT><COM></TT> with the appropriate domain components of your domain name.  You will be prompted for the "<TT>secret</TT>" specified in <TT>slapd.conf</TT>. For example, for <TT>example.com</TT>, use:

cvsdist

7a16c4a

<TT>ldapadd -x -D "cn=Manager,dc=example,dc=com" -W -f example.ldif</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

where <TT>example.ldif</TT> is the file you created above.

cvsdist

7a16c4a

<TT> </TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

Additional informaton regarding directory creation can be found in the Database Creation and Maintenance Tools chapter of this document.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

See if it works.

cvsdist

7a16c4a

cvsdist

7a16c4a

Now we're ready to verify the added entries are in your directory. You can use any LDAP client to do this, but our example uses the ldapsearch(1) tool.  Remember to replace <TT>dc=example,dc=com</TT> with the correct values for your site:

cvsdist

7a16c4a

<TT>ldapsearch -x -b 'dc=example,dc=com' '(objectclass=*)'</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

This command will search for and retrieve every entry in the database.

cvsdist

7a16c4a

You are now ready to add more entries using ldapadd(1) or another LDAP client, experiment with various configuration options, backend arrangements, etc.

cvsdist

7a16c4a

Note that by default, the slapd(8) database grants read access to everybody excepting the super-user (as specified by the <TT>rootdn</TT> configuration directive).  It is highly recommended that you establish controls to restrict access to authorized users.  Access controls are discussed in the Access Control section of the The slapd Configuration File chapter.

cvsdist

7a16c4a

The following chapters provide more detailed information on making, installing, and running slapd(8).

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

3. The Big Picture - Configuration Choices

cvsdist

7a16c4a

This section gives a brief overview of various <TERM>LDAP</TERM> directory configurations, and how your stand-alone LDAP server slapd(8) fits in with the rest of the world.

cvsdist

7a16c4a

3.1. Local Directory Service

cvsdist

7a16c4a

In this configuration, you run a slapd which provides directory service for your local domain only. It does not interact with other directory servers in any way. This configuration is shown in Figure 3.1.

cvsdist

7a16c4a

<CENTER></CENTER>

cvsdist

7a16c4a

Figure 3.1: Local service configuration.

cvsdist

7a16c4a

Use this configuration if you are just starting out (it's the one the quick-start guide makes for you) or if you want to provide a local service and are not interested in connecting to the rest of the world. It's easy to upgrade to another configuration later if you want.

cvsdist

7a16c4a

3.2. Local Directory Service with Referrals

cvsdist

7a16c4a

In this configuration, you run a slapd which provides directory service for your local domain and configure it to return referrals to a superior service capable of requests outside your local domain. You may run this service yourself or use one provided to you. This configuration is shown in Figure 3.2.

cvsdist

7a16c4a

<CENTER></CENTER>

cvsdist

7a16c4a

Figure 3.2: Local service with referrals

cvsdist

7a16c4a

Use this configuration if you want to provide local service and participate in the Global Directory.

cvsdist

7a16c4a

3.3. Replicated Directory Service

cvsdist

7a16c4a

The slurpd daemon is used to propagate changes from a master slapd to one or more slave slapds. An example master-slave configuration is shown in figure 3.3.

cvsdist

7a16c4a

<CENTER></CENTER>

cvsdist

7a16c4a

Figure 3.3: Replicated Directory Services

cvsdist

7a16c4a

This configuration can be used in conjunction with either of first two configurations in situations where a single slapd does not provide the required reliability or availability.

cvsdist

7a16c4a

3.4. Distributed Local Directory Service

cvsdist

7a16c4a

In this configuration, the local service is partitioned into smaller services, each which may be replicated, and glued together with superior and subordinate referrals.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

4. Building and Installing OpenLDAP Software

cvsdist

7a16c4a

This chapter details how to build and install the OpenLDAP Software package including slapd(8), the stand-alone LDAP daemon and slurpd(8), the stand-alone update replication daemon. Building and installing OpenLDAP requires several steps: installing prerequisite software, configuring OpenLDAP itself, making, and finally installing.  The following sections describe this process in detail.

cvsdist

7a16c4a

4.1. Obtaining and Extracting the Software

cvsdist

7a16c4a

You can obtain OpenLDAP Software from the project's download page at http://www.openldap.org/software/download/ or directly from the project's <TERM>FTP</TERM> service at ftp://ftp.openldap.org/pub/OpenLDAP/.

cvsdist

7a16c4a

The project makes available two series of packages for general use.  The project makes releases as new features and bug fixes come available.  Though the project takes steps to improve stablity of these releases, it is common for problems to arise only after release.  The latest release which has demonstrated stability through general use.

cvsdist

7a16c4a

Users of OpenLDAP Software can choose, depending on their desire for the latest features versus demonstrated stability, the most appropriate series to install.

cvsdist

7a16c4a

After downloading OpenLDAP Software, you need to extract the distribution from the compressed archive file and change your working directory to the top directory of the distribution:

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>gunzip -c openldap-VERSION.tgz | tar xf -</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>cd openldap-VERSION</TT>

cvsdist

7a16c4a

You'll have to replace <TT>VERSION</TT> with the version name of the release.

cvsdist

7a16c4a

You should now review the <TT>COPYRIGHT</TT>, <TT>LICENSE</TT>, <TT>README</TT> and <TT>INSTALL</TT> documents provided with the distribution.  The <TT>COPYRIGHT</TT> and <TT>LICENSE</TT> provide information on acceptable use, copying, and limitation of warranty of OpenLDAP software. The <TT>README</TT> and <TT>INSTALL</TT> documents provide detailed information on prerequisite software and installation procedures.

cvsdist

7a16c4a

4.2. Prerequisite software

cvsdist

7a16c4a

OpenLDAP Software relies upon a number of software packages distributed by third parties.  Depending on the features you intend to use, you may have to download and install a number of additional software packages.  This section details commonly needed third party software packages you might have to install.  Note that some of these third party packages may depend on additional software packages.  Install each package per installation instructions provided with it.

cvsdist

7a16c4a

4.2.1. <TERM>Transport Layer Security</TERM>

cvsdist

7a16c4a

OpenLDAP clients and servers require installation of OpenSSL <TERM>TLS</TERM> libraries to provide <TERM>Transport Layer Security</TERM> services.  Though some operating systems may provide these libraries as part of the base system or as an optional software component, OpenSSL often requires separate installation.

cvsdist

7a16c4a

OpenSSL is available from http://www.openssl.org/.

cvsdist

7a16c4a

OpenLDAP will not be fully LDAPv3 compliant unless OpenLDAP's <TT>configure</TT> detects a usable OpenSSL installation.

cvsdist

7a16c4a

4.2.2. Kerberos Authentication Services

cvsdist

7a16c4a

OpenLDAP clients and servers support Kerberos-based authentication services. In particular, OpenLDAP supports <TERM>SASL</TERM>/<TERM>GSSAPI</TERM> authentication mechanism using either Heimdal or MIT Kerberos V packages. If you desire to use Kerberos-based SASL/GSSAPI authentication, you should install either Heimdal or MIT Kerberos V.

cvsdist

7a16c4a

Heimdal Kerberos is available from http://www.pdc.kth.se/heimdal/. MIT Kerberos is available from http://web.mit.edu/kerberos/www/.

cvsdist

7a16c4a

Use of strong authentication services, such as those provided by Kerberos, is highly recommended.

cvsdist

7a16c4a

4.2.3. <TERM>Simple Authentication and Security Layer</TERM>

cvsdist

7a16c4a

OpenLDAP clients and servers require installation of Cyrus's SASL libraries to provide <TERM>Simple Authentication and Security Layer</TERM> services.  Though some operating systems may provide this library as part of the base system or as an optional software component, Cyrus SASL often requires separate installation.

cvsdist

7a16c4a

Cyrus SASL is available from http://asg.web.cmu.edu/sasl/sasl-library.html. Cyrus SASL will make use of OpenSSL and Kerberos/GSSAPI libraries if preinstalled.

cvsdist

7a16c4a

OpenLDAP will not be fully LDAPv3 compliant unless OpenLDAP's configure detects a usable Cyrus SASL installation.

cvsdist

7a16c4a

4.2.4. Database Software

cvsdist

7a16c4a

OpenLDAP's slapd(8) primary database backend, <TERM>LDBM</TERM>, requires a compatible database package for entry storage.  LDBM is compatible with Sleepycat Software's BerkeleyDB (recommended) or the Free Software Foundation's GNU Database Manager (GDBM). If neither of these packages are available at configure time, you will not be able build slapd(8) with primary database backend.

cvsdist

7a16c4a

Your operating system may provide one of these two packages in the base system or as an optional software component.  You may need may need to obtain the software and install it yourself.

cvsdist

7a16c4a

BerkeleyDB is available from Sleepycat Software's download page http://www.sleepycat.com/download.html. There are several versions available.  At the time of this writing, the latest release, version 3.1, is recommended.

cvsdist

7a16c4a

GDBM is available from FSF's download site ftp://ftp.gnu.org/pub/gnu/gdbm/. At the time of this writing, version 1.8 is the latest release.

cvsdist

7a16c4a

4.2.5. Threads

cvsdist

7a16c4a

OpenLDAP is designed to take advantage of threads.  OpenLDAP supports POSIX pthreads, Mach CThreads, and a number of other varieties.  <TT>configure</TT> will complain if it cannot find a suitable thread subsystem.   If this occurs, please consult the <TT>Software|Installation|Platform Hints</TT> section of the OpenLDAP FAQ http://www.openldap.org/faq/.

cvsdist

7a16c4a

4.2.6. TCP Wrappers

cvsdist

7a16c4a

slapd(8) supports TCP wrappers (IP level access control filters) if preinstalled.  Use of TCP wrappers or other IP-level access filters (such as those provided by an IP-level firewall) is recommended for servers containing non-public information.

cvsdist

7a16c4a

4.3. Running configure

cvsdist

7a16c4a

Now you should probably run the <TT>configure</TT> script with the <TT>--help</TT> option. This will give you a list of options that you can change when building OpenLDAP.  Many of the features of OpenLDAP can be enabled or disabled using this method.

cvsdist

7a16c4a

cvsdist

7a16c4a

        ./configure --help

cvsdist

7a16c4a

cvsdist

7a16c4a

The <TT>configure</TT> script will also look at various environment variables for certain settings.  These environment variables include:

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 4.1: Environment Variables</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Variable

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>CC</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify alternative C Compiler

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>CFLAGS</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify additional compiler flags

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>CPPFLAGS</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify C Preprocessor flags

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>LDFLAGS</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify linker flags

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>LIBS</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify additional libraries

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Now run the configure script with any desired configuration options or environment variables.

cvsdist

7a16c4a

cvsdist

7a16c4a

        [[env] settings] ./configure [options]

cvsdist

7a16c4a

cvsdist

7a16c4a

As an example, let's assume that we want install OpenLDAP with LDBM backend and TCP wrapper support.  By default, LDBM is enabled and TCP wrappers is not.  So, we just need to specify <TT>--with-wrappers</TT> to include TCP wrapper support:

cvsdist

7a16c4a

cvsdist

7a16c4a

        ./configure --with-wrappers

cvsdist

7a16c4a

cvsdist

7a16c4a

However, this will fail to locate dependent software not installed in system directories.  For example, if TCP Wrappers headers and libraries are installed in <TT>/usr/local/include</TT> and <TT>/usr/local/lib</TT> respectively, the <TT>configure</TT> script should be called as follows:

cvsdist

7a16c4a

cvsdist

7a16c4a

        env CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" \

cvsdist

7a16c4a

                ./configure --with-wrappers

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: Some shells, such as those derived from the Bourne sh(1), do not require use of the env(1) command.  In some cases, environmental variables have to be specified using alternative syntaxes.

cvsdist

7a16c4a

cvsdist

7a16c4a

The <TT>configure</TT> script will normally auto-detect appropriate settings.  If you have problems at this stage, consult any platform specific hints and check your <TT>configure</TT> options, if any.

cvsdist

7a16c4a

4.4. Building the Software

cvsdist

7a16c4a

Once you have run the <TT>configure</TT> script the last line of output should be:

cvsdist

7a16c4a

cvsdist

7a16c4a

        Please "make depend" to build dependencies

cvsdist

7a16c4a

cvsdist

7a16c4a

If the last line of output does not match, <TT>configure</TT> has failed, and you will need to review its output to determine what went wrong. You should not proceed until <TT>configure</TT> completes successfully.

cvsdist

7a16c4a

To build dependencies, run:

cvsdist

7a16c4a

cvsdist

7a16c4a

        make depend

cvsdist

7a16c4a

cvsdist

7a16c4a

Now build the software, this step will actually compile OpenLDAP.

cvsdist

7a16c4a

cvsdist

7a16c4a

        make

cvsdist

7a16c4a

cvsdist

7a16c4a

You should examine the output of this command carefully to make sure everything is built correctly. Note that this command builds the LDAP libraries and associated clients as well as slapd(8) and slurpd(8).

cvsdist

7a16c4a

4.5. Testing the Software

cvsdist

7a16c4a

Once the software has been properly configured and successfully made, you should run the test suite to verify the build.

cvsdist

7a16c4a

cvsdist

7a16c4a

        make test

cvsdist

7a16c4a

cvsdist

7a16c4a

Tests which apply to your configuration will run and they should pass. Some tests, such as the replication test, may be skipped if not supported by your configuration.

cvsdist

7a16c4a

4.6. Installing the Software

cvsdist

7a16c4a

One you have successfully tested the software, you are ready to install it. You will need to have write permission to the installation directories you specified when you ran configure. By default OpenLDAP is installed in <TT>/usr/local</TT>.  If you changed this setting with the <TT>--prefix</TT> configure option, it will be installed in the location you provided.

cvsdist

7a16c4a

Typically, the installation typically requires super-user priviledges. From the top level OpenLDAP source directory, type:

cvsdist

7a16c4a

cvsdist

7a16c4a

        su root -c 'make install'

cvsdist

7a16c4a

cvsdist

7a16c4a

You should examine the output of this command carefully to make sure everything is installed correctly. You will find the configuration files for slapd(8) in <TT>/usr/local/etc/openldap</TT> by default.  See the The slapd Configuration File chapter for additional information.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

5. The slapd Configuration File

cvsdist

7a16c4a

Once the software has been built and installed, you are ready to configure slapd(8) for use at your site. The slapd runtime configuration is primarily accomplished through the slapd.conf(5) file, normally installed in the <TT>/usr/local/etc/openldap</TT> directory.

cvsdist

7a16c4a

An alternate configuration file can be specified via a command-line option to slapd(8) or slurpd(8). This chapter describes the general format of the config file, followed by a detailed description of commonly used config file directives.

cvsdist

7a16c4a

5.1. Configuration File Format

cvsdist

7a16c4a

The slapd.conf(5) file consists of three types of configuration information: global, backend specific, and database specific.  Global information is specified first, followed by information associated with a particular backend type, which is then followed by information associated with a particular database instance.  Global directives can be overridden in a backend and/or database directives, backend directives can be overridden by database directives.

cvsdist

7a16c4a

Blank lines and comment lines beginning with a '<TT>#</TT>' character are ignored.  If a line begins with white space, it is considered a continuation of the previous line. The general format of slapd.conf is as follows:

cvsdist

7a16c4a

cvsdist

7a16c4a

        # global configuration directives

cvsdist

7a16c4a

        <global config directives>

cvsdist

7a16c4a

cvsdist

7a16c4a

        # backend definition

cvsdist

7a16c4a

        backend <typeA>

cvsdist

7a16c4a

        <backend-specific directives>

cvsdist

7a16c4a

cvsdist

7a16c4a

        # first database definition & config directives

cvsdist

7a16c4a

        database <typeA>

cvsdist

7a16c4a

        <database-specific directives>

cvsdist

7a16c4a

cvsdist

7a16c4a

        # second database definition & config directives

cvsdist

7a16c4a

        database <typeB>

cvsdist

7a16c4a

        <database-specific directives>

cvsdist

7a16c4a

cvsdist

7a16c4a

        # second database definition & config directives

cvsdist

7a16c4a

        database <typeA>

cvsdist

7a16c4a

        <database-specific directives>

cvsdist

7a16c4a

cvsdist

7a16c4a

        # subsequent backend & database definitions & config directives

cvsdist

7a16c4a

...

cvsdist

7a16c4a

cvsdist

7a16c4a

A configuration directive may take arguments.  If so, they are separated by white space.  If an argument contains white space, the argument should be enclosed in double quotes <TT>"like this"</TT>. If an argument contains a double quote or a backslash character `<TT>\</TT>', the character should be preceded by a backslash character `<TT>\</TT>'.

cvsdist

7a16c4a

The distribution contains an example configuration file that will be installed in the <TT>/usr/local/etc/openldap</TT> directory. A number of files containing schema definitions (attribute types and object classes) are also provided in the <TT>/usr/local/etc/openldap/schema</TT> directory.

cvsdist

7a16c4a

5.2. Configuration File Directives

cvsdist

7a16c4a

This section details commonly used configuration directives.  For a complete list, see slapd.conf(5) manual page.  This section separates the configuration file directives into global, backend-specific and data-specific categories, describing each directive and its default value (if any), and giving an example of its use.

cvsdist

7a16c4a

5.2.1. Global Directives

cvsdist

7a16c4a

Directives described in this section apply to all backends and databases unless specifically overridden in a backend or database definition.  Arguments that should be replaced by actual text are shown in brackets <TT><></TT>.

cvsdist

7a16c4a

5.2.1.1. access to <what> [ by <who> <accesslevel> <control> ]+

cvsdist

7a16c4a

This directive grants access (specified by <accesslevel>) to a set of entries and/or attributes (specified by <what>) by one or more requesters (specified by <who>). See the Access Control section of this chapter for a summary of basic usage.

cvsdist

7a16c4a

 5.2.1.2. attributetype <RFC2252 Attribute Type Description>

cvsdist

7a16c4a

This directive defines an attribute type. Please see the Schema Specification chapter for information regarding how to use this directive.

cvsdist

7a16c4a

5.2.1.3. defaultaccess { none | compare | search | read | write }

cvsdist

7a16c4a

This directive specifies the default access to grant requesters when no <TT>access</TT> directives have been specified.  Any given access level implies all lesser access levels (e.g., read access implies search and compare but not write).

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: It is recommend that the <TT>access</TT> directive be used to specify access control.  See the Access Control section of this chapter for information regarding the <TT>access</TT> directive.

cvsdist

7a16c4a

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

 defaultaccess read

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.1.4. idletimeout <integer>

cvsdist

7a16c4a

Specify the number of seconds to wait before forcibly closing an idle client connection.  An idletimeout of 0, the default, disables this feature.

cvsdist

7a16c4a

5.2.1.5. include <filename>

cvsdist

7a16c4a

This directive specifies that slapd should read additional configuration information from the given file before continuing with the next line of the current file. The included file should follow the normal slapd config file format.  The file is commonly used to include files containing schema specifications.

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: You should be careful when using this directive - there is no small limit on the number of nested include directives, and no loop detection is done.

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.1.6. loglevel <integer>

cvsdist

7a16c4a

This directive specifies the level at which debugging statements and operation statistics should be syslogged (currently logged to the syslogd(8) {EX:LOG_LOCAL4}} facility). You must have configured OpenLDAP <TT>--enable-debug</TT> (the default) for this to work (except for the two statistics levels, which are always enabled).  Log levels are additive. To display what numbers correspond to what kind of debugging, invoke slapd with <TT>-?</TT> or consult the table below. The possible values for <integer> are:

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 5.1: Debugging Levels</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Level

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

-1

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

enable all debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

no debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

trace function calls

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

debug packet handling

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

heavy trace debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

connection management

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print out packets sent and received

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

search filter processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

configuration file processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

access control list processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

stats log connections/operations/results

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

stats log entries sent

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print communication with shell backends

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print entry parsing debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

 loglevel -1

cvsdist

7a16c4a

cvsdist

7a16c4a

This will cause lots and lots of debugging information to be logged.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

 loglevel 256

cvsdist

7a16c4a

cvsdist

7a16c4a

 5.2.1.7. objectclass <RFC2252 Object Class Description>

cvsdist

7a16c4a

This directive defines an object class. Please see the Schema Specification chapter for information regarding how to use this directive.

cvsdist

7a16c4a

5.2.1.8. referral <URI>

cvsdist

7a16c4a

This directive specifies the referral to pass back when slapd cannot find a local database to handle a request.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        referral ldap://root.openldap.org

cvsdist

7a16c4a

cvsdist

7a16c4a

This will refer non-local queries to the global root LDAP server at the OpenLDAP Project. Smart LDAP clients can re-ask their query at that server, but note that most of these clients are only going to know how to handle simple LDAP URLs that contain a host part and optionally a distinguished name part.

cvsdist

7a16c4a

5.2.1.9. sizelimit <integer>

cvsdist

7a16c4a

This directive specifies the maximum number of entries to return from a search operation.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        sizelimit 500

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.1.10. timelimit <integer>

cvsdist

7a16c4a

This directive specifies the maximum number of seconds (in real time) slapd will spend answering a search request. If a request is not finished in this time, a result indicating an exceeded timelimit will be returned.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        timelimit 3600

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.2. General Backend Directives

cvsdist

7a16c4a

Directives in this section apply only to the backend in which they are defined. They are supported by every type of backend. Backend directives apply to all databases instances of the same type and, depending on the directive, may be overridden by database directives.

cvsdist

7a16c4a

5.2.2.1. backend <type>

cvsdist

7a16c4a

This directive marks the beginning of a backend definition. <TT><type></TT> should be one of <TT>ldbm</TT>, <TT>shell</TT>, <TT>passwd</TT>, or other supported backend type.

cvsdist

7a16c4a

5.2.3. General Database Directives

cvsdist

7a16c4a

Directives in this section apply only to the database in which they are defined. They are supported by every type of database.

cvsdist

7a16c4a

5.2.3.1. database <type>

cvsdist

7a16c4a

This directive marks the beginning of a new database instance definition. <TT><type></TT> should be one of <TT>ldbm</TT>, <TT>shell</TT>, <TT>passwd</TT>, or other supported database type.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        database ldbm

cvsdist

7a16c4a

cvsdist

7a16c4a

This marks the beginning of a new LDBM backend database instance definition.

cvsdist

7a16c4a

5.2.3.2. readonly { on | off }

cvsdist

7a16c4a

This directive puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        readonly off

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.3.3. replica

cvsdist

7a16c4a

cvsdist

7a16c4a

        replica host=<hostname>[:<port>]

cvsdist

7a16c4a

                [bindmethod={ simple | kerberos | sasl }]

cvsdist

7a16c4a

                ["binddn=<DN>"]

cvsdist

7a16c4a

                [mech=<mech>]

cvsdist

7a16c4a

                [authcid=<identity>]

cvsdist

7a16c4a

                [authzid=<identity>]

cvsdist

7a16c4a

                [credentials=<password>]

cvsdist

7a16c4a

                [srvtab=<filename>]

cvsdist

7a16c4a

cvsdist

7a16c4a

This directive specifies a replication site for this database. The <TT>host=</TT> parameter specifies a host and optionally a port where the slave slapd instance can be found. Either a domain name or IP address may be used for <hostname>. If <port> is not given, the standard LDAP port number (389) is used.

cvsdist

7a16c4a

The <TT>binddn=</TT> parameter gives the DN to bind as for updates to the slave slapd. It should be a DN which has read/write access to the slave slapd's database, typically given as a <TT>rootdn</TT> in the slave's config file. It must also match the <TT>updatedn</TT> directive in the slave slapd's config file. Since DNs are likely to contain embedded spaces, the entire <TT>"binddn=<DN>"</TT> string should be enclosed in double quotes.

cvsdist

7a16c4a

The <TT>bindmethod</TT> is <TT>simple</TT> or <TT>kerberos</TT> or <TT>sasl</TT>, depending on whether simple password-based authentication or Kerberos authentication or <TERM>SASL</TERM> authentication is to be used when connecting to the slave slapd.

cvsdist

7a16c4a

Simple authentication should not be used unless adequate integrity and privacy protections are in place (e.g. TLS or IPSEC).  Simple authentication requires specification of <TT>binddn</TT> and <TT>credentials</TT> parameters.

cvsdist

7a16c4a

Kerberos authentication is deprecated in favor of SASL authentication mechanisms, in particular the <TT>KERBEROS_V4</TT> and <TT>GSSAPI</TT> mechanisms.  Kerberos authentication requires <TT>binddn</TT> and <TT>srvtab</TT> parameters.

cvsdist

7a16c4a

SASL authentication is generally recommended.  SASL authentication requires specification of a mechanism using the <TT>mech</TT> parameter. Depending on the mechanism, an authentication identity and/or credentials can be specified using <TT>authcid</TT> and <TT>credentials</TT> respectively.  The <TT>authzid</TT> parameter may be used to specify an authorization identity.

cvsdist

7a16c4a

See the chapter entitled Replication with slurpd for more information on how to use this directive.

cvsdist

7a16c4a

5.2.3.4. replogfile <filename>

cvsdist

7a16c4a

This directive specifies the name of the replication log file to which slapd will log changes. The replication log is typically written by slapd and read by slurpd. Normally, this directive is only used if slurpd is being used to replicate the database. However, you can also use it to generate a transaction log, if slurpd is not running. In this case, you will need to periodically truncate the file, since it will grow indefinitely otherwise.

cvsdist

7a16c4a

See the chapter entitled Replication with slurpd for more information on how to use this directive.

cvsdist

7a16c4a

5.2.3.5. rootdn <dn>

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Entry-based Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        rootdn "cn=Manager,dc=example,dc=com"

cvsdist

7a16c4a

cvsdist

7a16c4a

SASL-based Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        rootdn "uid=root@EXAMPLE.COM"

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.3.6. rootpw <password>

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        rootpw secret

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.3.7. suffix <dn suffix>

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        suffix "dc=example,dc=com"

cvsdist

7a16c4a

cvsdist

7a16c4a

Queries with a DN ending in "dc=example,dc=com" will be passed to this backend.

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: When the backend to pass a query to is selected, slapd looks at the suffix line(s) in each database definition in the order they appear in the file. Thus, if one database suffix is a prefix of another, it must appear after it in the config file.

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.3.8. updatedn <dn>

cvsdist

7a16c4a

This directive is only applicable in a slave slapd. It specifies the DN allowed to make changes to the replica.  This may be the DN slurpd(8) binds as when making changes to the replica or the DN associated with a SASL identity.

cvsdist

7a16c4a

Entry-based Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        updatedn "cn=Update Daemon,dc=example,dc=com"

cvsdist

7a16c4a

cvsdist

7a16c4a

SASL-based Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        updatedn "uid=slurpd@EXAMPLE.COM"

cvsdist

7a16c4a

cvsdist

7a16c4a

See the Replication chapter for more information on how to use this directive.

cvsdist

7a16c4a

5.2.3.9. updateref <URL>

cvsdist

7a16c4a

This directive is only applicable in a slave slapd. It specifies the URL to return to clients which submit update requests upon the replica. If specified multiple times, each <TERM>URL</TERM> is provided.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        updateref       ldap://master.example.net

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.4. LDBM Backend-Specific Directives

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

5.2.4.1. cachesize <integer>

cvsdist

7a16c4a

This directive specifies the size in entries of the in-memory cache maintained by the LDBM backend database instance.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        cachesize 1000

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.4.2. dbcachesize <integer>

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dbcachesize 100000

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.4.3. dbnolocking

cvsdist

7a16c4a

This option, if present, disables database locking. Enabling this option may improve performance at the expense of data security.

cvsdist

7a16c4a

5.2.4.4. dbnosync

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

5.2.4.5. directory <directory>

cvsdist

7a16c4a

This directive specifies the directory where the LDBM files containing the database and associated indexes live.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        directory /usr/local/var/openldap-ldbm

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.4.6. index {<attrlist> | default} [pres,eq,approx,sub,none]

cvsdist

7a16c4a

This directive specifies the indexes to maintain for the given attribute. If only an <TT><attrlist></TT> is given, the default indexes are maintained.

cvsdist

7a16c4a

Example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        index default pres,eq

cvsdist

7a16c4a

        index objectClass,uid

cvsdist

7a16c4a

        index cn,sn eq,sub,approx

cvsdist

7a16c4a

cvsdist

7a16c4a

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 <TT>objectClass</TT> and <TT>uid</TT> attribute types.  The third line causes equality, substring, and approximate indices to be maintained for <TT>cn</TT> and <TT>sn</TT> attribute types.

cvsdist

7a16c4a

5.2.4.7. mode <integer>

cvsdist

7a16c4a

This directive specifies the file protection mode that newly created database index files should have.

cvsdist

7a16c4a

Default:

cvsdist

7a16c4a

cvsdist

7a16c4a

        mode 0600

cvsdist

7a16c4a

cvsdist

7a16c4a

5.2.5. Other Backend Databases

cvsdist

7a16c4a

slapd(8) supports a number of backend database types besides the default LDBM.

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 5.2: Backend Database Types</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Types

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>ldbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Berkeley or GNU DBM compatible backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>passwd</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Provides read-only access to <TT>/etc/passwd</TT>

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>shell</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Shell (extern program) backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>sql</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

SQL Programmable backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

See slapd.conf(5) for details.

cvsdist

7a16c4a

5.3. Access Control

cvsdist

7a16c4a

Access to slapd entries and attributes is controlled by the access configuration file directive. The general form of an access line is:

cvsdist

7a16c4a

cvsdist

7a16c4a

        <access directive> ::= access to <what>

cvsdist

7a16c4a

                [by <who> <access> <control>]+

cvsdist

7a16c4a

        <what> ::= * | [ dn[.<target style>]=<regex>]

cvsdist

7a16c4a

                [filter=<ldapfilter>] [attrs=<attrlist>]

cvsdist

7a16c4a

        <target style> ::= regex | base | one | subtree | children

cvsdist

7a16c4a

        <attrlist> ::= <attr> | <attr> , <attrlist>

cvsdist

7a16c4a

        <attr> ::= <attrname> | entry | children

cvsdist

7a16c4a

        <who> ::= [* | anonymous | users | self |

cvsdist

7a16c4a

                dn[.<subject style>]=<regex>]

cvsdist

7a16c4a

                [dnattr=<attrname> ]

cvsdist

7a16c4a

                [group[/<objectclass>[/<attrname>][.<basic style>]]=<regex> ]

cvsdist

7a16c4a

                [peername[.<basic style>]=<regex>]

cvsdist

7a16c4a

                [sockname[.<basic style>]=<regex>]

cvsdist

7a16c4a

                [domain[.<basic style>]=<regex>]

cvsdist

7a16c4a

                [sockurl[.<basic style>]=<regex>]

cvsdist

7a16c4a

                [set=<setspec>]

cvsdist

7a16c4a

                [aci=<attrname>]

cvsdist

7a16c4a

        <subject style> ::= regex | exact | base | one | subtree | children

cvsdist

7a16c4a

        <basic style> ::= regex | exact

cvsdist

7a16c4a

        <access> ::= [self]{<level>|<priv>}

cvsdist

7a16c4a

        <level> ::= none | auth | compare | search | read | write

cvsdist

7a16c4a

        <priv> ::= {=|+|-}{w|r|s|c|x}+

cvsdist

7a16c4a

        <control> ::= [stop | continue | break]

cvsdist

7a16c4a

cvsdist

7a16c4a

where the <what> part selects the entries and/or attributes to which the access applies, the <TT><who></TT> part specifies which entities are granted access, and the <TT><access></TT> part specifies the access granted. Multiple <TT><who> <access> <control></TT> triplets are supported, allowing many entities to be granted different access to the same set of entries and attributes.

cvsdist

7a16c4a

5.3.1. What to control access to

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dn=<regular expression>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

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 "<TT>cn=Babs Jensen,dc=example,dc=com</TT>".  An example of a non-normalized DN is "<TT>cn=Babs Jensen; dc=example; dc=com</TT>".

cvsdist

7a16c4a

cvsdist

7a16c4a

Or, entries may be selected by a filter matching some attribute(s) in the entry:

cvsdist

7a16c4a

cvsdist

7a16c4a

        filter=<ldap filter>

cvsdist

7a16c4a

cvsdist

7a16c4a

where <ldap filter> is a string representation of an LDAP search filter, as described in RFC2254.

cvsdist

7a16c4a

Attributes within an entry are selected by including a comma-separated list of attribute names in the <what> selector:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attrs=<attribute list>

cvsdist

7a16c4a

cvsdist

7a16c4a

Access to the entry itself must be granted or denied using the special attribute name "<TT>entry</TT>". Note that giving access to an attribute is not enough; access to the entry itself through the <TT>entry</TT> attribute is also required. The complete examples at the end of this section should help clear things up.

cvsdist

7a16c4a

Lastly, there is a special entry selector <TT>"*"</TT> that is used to select any entry.  It is used when no other <TT><what></TT> selector has been provided.  It's equivalent to "<TT>dn=.*</TT>"

cvsdist

7a16c4a

5.3.2. Who to grant access to

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 5.3: Access Entity Specifiers</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Specifier

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Entities

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>*</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

All, including anonymous and authenticated users

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>anonymous</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Anonymous (non-authenticated) users

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>users</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Authenticated users

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>self</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

User associated with target entry

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>dn=<regex></TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Users matching regular expression

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

The DN specifier takes a regular expression which is used to match against the "normalized" DN of the current entity.

cvsdist

7a16c4a

cvsdist

7a16c4a

        dn=<regular expression>

cvsdist

7a16c4a

cvsdist

7a16c4a

By "normalized", we mean that all extra spaces have been removed from the entity's DN and commas are used to separate RDN components.

cvsdist

7a16c4a

Other control factors are also supported. For example, a <TT><what></TT> can be restricted by a regular expression matching the client's domain name:

cvsdist

7a16c4a

cvsdist

7a16c4a

        domain=<regular expression>

cvsdist

7a16c4a

cvsdist

7a16c4a

or by an entry listed in a DN-valued attribute in the entry to which the access applies:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dnattr=<dn-valued attribute name>

cvsdist

7a16c4a

cvsdist

7a16c4a

The dnattr specification is used to give access to an entry whose DN is listed in an attribute of the entry (e.g., give access to a group entry to whoever is listed as the owner of the group entry).

cvsdist

7a16c4a

5.3.3. The access to grant

cvsdist

7a16c4a

The kind of <access> granted can be one of the following:

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 5.4: Access Levels</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Level

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Privileges

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>none</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT> </TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

no access

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>auth</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>=x</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

needed to bind

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>compare</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>=cx</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

needed to compare

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>search</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>=scx</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

needed to apply search filters

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>read</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>=rscx</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

needed to read search results

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>write</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>=wrscx</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

needed to modify/rename

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Each level implies all lower levels of access. So, for example, granting someone <TT>write</TT> access to an entry also grants them <TT>read</TT>, <TT>search</TT>, <TT>compare</TT>, and <TT>auth</TT> access.  However, one may use the privileges specifier to grant specific permissions.

cvsdist

7a16c4a

5.3.4. Access Control Evaluation

cvsdist

7a16c4a

When evaluating whether some requester should be given access to an entry and/or attribute, slapd compares the entry and/or attribute to the <TT><what></TT> 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 <TT><what></TT> selector that matches the entry and/or attribute. The corresponding access directive is the one slapd will use to evaluate access.

cvsdist

7a16c4a

Next, slapd compares the entity requesting access to the <TT><who></TT> selectors within the access directive selected above in the order in which they appear. It stops with the first <TT><who></TT> selector that matches the requester. This determines the access the entity requesting access has to the entry and/or attribute.

cvsdist

7a16c4a

Finally, slapd compares the access granted in the selected <TT><access></TT> clause to the access requested by the client. If it allows greater or equal access, access is granted. Otherwise, access is denied.

cvsdist

7a16c4a

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 <TT><who></TT> 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.

cvsdist

7a16c4a

5.3.5. Access Control Examples

cvsdist

7a16c4a

The access control facility described above is quite powerful. This section shows some examples of its use. First, some simple examples:

cvsdist

7a16c4a

cvsdist

7a16c4a

        access to * by * read

cvsdist

7a16c4a

cvsdist

7a16c4a

This access directive grants read access to everyone.

cvsdist

7a16c4a

cvsdist

7a16c4a

        access to *

cvsdist

7a16c4a

                by self write

cvsdist

7a16c4a

                by anonymous auth

cvsdist

7a16c4a

                by * read

cvsdist

7a16c4a

cvsdist

7a16c4a

This directive allows users to modify their own entries, allows authenticate, and allows authenticated users to read. Note that only the first <TT>by <who></TT> clause which matches applies. Hence, the anonymous users are granted <TT>auth</TT>, not <TT>read</TT>. The last clause could just as well have been "<TT>by users read</TT>".

cvsdist

7a16c4a

The following example shows the use of a regular expression to select the entries by DN in two access directives where ordering is significant.

cvsdist

7a16c4a

cvsdist

7a16c4a

        access to dn=".*,dc=example,dc=com"

cvsdist

7a16c4a

                by * search

cvsdist

7a16c4a

        access to dn=".*,dc=com"

cvsdist

7a16c4a

                by * read

cvsdist

7a16c4a

cvsdist

7a16c4a

Read access is granted to entries under the <TT>dc=com</TT> subtree, except for those entries under the <TT>dc=example,dc=com</TT> subtree, to which search access is granted.  No access is granted to <TT>dc=com</TT> 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 <TT>dc=example,dc=com</TT> entries are also <TT>dc=com</TT> entries.

cvsdist

7a16c4a

Also note that if no <TT>access to</TT> directive matches or no <TT>by <who></TT> clause, access is denied.  That is, every <TT>access to</TT> directive ends with an implicit <TT>by * none</TT> clause and every access list ends with an implicit <TT>access to * by * none</TT> directive.  Only if no access controls are specified is the <TT>defaultaccess</TT> granted.

cvsdist

7a16c4a

The next example again shows the importance of ordering, both of the access directives and the <TT>by <who></TT> clauses. It also shows the use of an attribute selector to grant access to a specific attribute and various <TT><who></TT> selectors.

cvsdist

7a16c4a

cvsdist

7a16c4a

        access to dn="(.*,)?dc=example,dc=com" attr=homePhone

cvsdist

7a16c4a

                by self write

cvsdist

7a16c4a

                by dn="(.*,)?dc=example,dc=com" search

cvsdist

7a16c4a

                by domain=.*\.example\.com read

cvsdist

7a16c4a

        access to dn="(.*,)?dc=example,dc=com"

cvsdist

7a16c4a

                by self write

cvsdist

7a16c4a

                by dn=".*,dc=example,dc=com" search

cvsdist

7a16c4a

                by anonymous auth

cvsdist

7a16c4a

cvsdist

7a16c4a

This example applies to entries in the "<TT>dc=example,dc=com</TT>" subtree. To all attributes except <TT>homePhone</TT>, the entry itself can write them, other <TT>example.com</TT> entries can search by them, anybody else has no access ((implicit <TT>by * none</TT>) excepting for authentication/authorization (which is always done anonymously). The <TT>homePhone</TT> attribute is writable by the entry, searchable by other <TT>example.com</TT> entries, readable by clients connecting from somewhere in the <TT>example.com</TT> domain, and otherwise not readable (implicit <TT>by * none</TT>).  All other access is denied by the implicit <TT>access to * by * none</TT>.

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

        access to attr=member,entry

cvsdist

7a16c4a

                by dnattr=member selfwrite

cvsdist

7a16c4a

cvsdist

7a16c4a

The dnattr <TT><who></TT> selector says that the access applies to entries listed in the <TT>member</TT> attribute. The <TT>selfwrite</TT> 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.

cvsdist

7a16c4a

5.4. Configuration File Example

cvsdist

7a16c4a

The following is an example configuration file, interspersed with explanatory text. It defines two databases to handle different parts of the <TERM>X.500</TERM> tree; both are <TERM>LDBM</TERM> database instances. The line numbers shown are provided for reference only and are not included in the actual file. First, the global configuration section:

cvsdist

7a16c4a

cvsdist

7a16c4a

  1.    # example config file - global configuration section

cvsdist

7a16c4a

  2.    include /usr/local/etc/schema/core.schema

cvsdist

7a16c4a

  3.    referral ldap://root.openldap.org

cvsdist

7a16c4a

  4.    access to * by * read

cvsdist

7a16c4a

cvsdist

7a16c4a

Line 1 is a comment. Line 2 includes another config file which containing core schema definitions. The <TT>referral</TT> 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 <TT>root.openldap.org</TT>.

cvsdist

7a16c4a

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).

cvsdist

7a16c4a

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 <TT>userPassword</TT> attribute is to be protected from unauthorized access.

cvsdist

7a16c4a

cvsdist

7a16c4a

  5.    # ldbm definition for the example.com

cvsdist

7a16c4a

  6.    database ldbm

cvsdist

7a16c4a

  7.    suffix "dc=example,dc=com"

cvsdist

7a16c4a

  8.    directory /usr/local/var/openldap

cvsdist

7a16c4a

  9.    rootdn "cn=Manager,dc=example,dc=com"

cvsdist

7a16c4a

 10.    rootpw secret

cvsdist

7a16c4a

 11.    # replication directives

cvsdist

7a16c4a

 12.    replogfile /usr/local/var/openldap/slapd.replog

cvsdist

7a16c4a

 13.    replica host=slave1.example.com:389

cvsdist

7a16c4a

 14.            binddn="cn=Replicator,dc=example,dc=com"

cvsdist

7a16c4a

 15.            bindmethod=simple credentials=secret

cvsdist

7a16c4a

 16.    replica host=slave2.example.com

cvsdist

7a16c4a

 17.            binddn="cn=Replicator,dc=example,dc=com"

cvsdist

7a16c4a

 18.            bindmethod=simple credentials=secret

cvsdist

7a16c4a

 19.    # indexed attribute definitions

cvsdist

7a16c4a

 20.    index uid pres,eq

cvsdist

7a16c4a

 21.    index cn,sn,uid pres,eq,approx,sub

cvsdist

7a16c4a

 22.    index objectClass eq

cvsdist

7a16c4a

 23.    # ldbm access control definitions

cvsdist

7a16c4a

 24.    access to attr=userPassword

cvsdist

7a16c4a

 25.            by self write

cvsdist

7a16c4a

 26.            by anonymous auth

cvsdist

7a16c4a

 27.            by dn="cn=Admin,dc=example,dc=com" write

cvsdist

7a16c4a

 28.            by * none

cvsdist

7a16c4a

 29.    access to *

cvsdist

7a16c4a

 30.            by self write

cvsdist

7a16c4a

 31.            by dn="cn=Admin,dc=example,dc=com" write

cvsdist

7a16c4a

 32.            by users read

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Lines 20 through 22 indicate the indexes to maintain for various attributes.

cvsdist

7a16c4a

Lines 24 through 32 specify access control for entries in the database. For all entries, the <TT>userPassword</TT> 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.

cvsdist

7a16c4a

The next section of the example configuration file defines another LDBM database. This one handles queries involving the <TT>dc=example,dc=net</TT> subtree.  Note that without line 38, the read access would be allowed due to the global access rule at line 4.

cvsdist

7a16c4a

cvsdist

7a16c4a

 33.    # ldbm definition for example.net

cvsdist

7a16c4a

 34.    database ldbm

cvsdist

7a16c4a

 35.    suffix "dc=example,dc=net"

cvsdist

7a16c4a

 36.    directory /usr/local/var/ldbm-example-net

cvsdist

7a16c4a

 37.    rootdn "cn=Manager,dc=example,dc=com"

cvsdist

7a16c4a

 38.    access to * by users read

cvsdist

cvsdist

cvsdist

cvsdist

6. Running slapd

cvsdist

7a16c4a

slapd(8) is designed to be run as a stand-alone server.  This allows the server to take advantage of caching, manage concurrency issues with underlying databases, and conserve system resources.  Running from inetd(8) is NOT an option.

cvsdist

7a16c4a

6.1. Command-Line Options

cvsdist

7a16c4a

slapd(8) supports a number of command-line options as detailed in the manual page.  This section details a few commonly used options.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -f <filename>

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies an alternate configuration file for slapd. The default is normally <TT>/usr/local/etc/openldap/slapd.conf</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -h <URLs>

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies alternative listener configurations.  The default is <TT>ldap:///</TT> which implies LDAP over TCP on all interfaces on the default LDAP port 389.  You can specify specific host-port pairs or other protocol schemes (such as ldaps:// or ldapi://).  For example, <TT>-h "ldaps:// ldap://127.0.0.1:666"</TT> will create two listeners: one for LDAP over SSL on all interfaces on the default LDAP/SSL port 636, and one for LDAP over TCP on the <TT>localhost</TT> (loopback) interface on port 666. Hosts may be specified using IPv4 dotted-decimal form or using host names.  Port values must be numeric.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -n <service-name>

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies the service name used for logging and other purposes.  The default service name is <TT>slapd</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -l <syslog-local-user>

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies the local user for the syslog(8) facility.  Values can be <TT>LOCAL0</TT>, <TT>LOCAL1</TT>, <TT>LOCAL2</TT>, ..., and <TT>LOCAL7</TT>.  The default is <TT>LOCAL4</TT>.  This option may not be supported on all systems.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -u user -g group

cvsdist

7a16c4a

cvsdist

7a16c4a

These options specify the user and group, respectively, to run as.  <TT>user</TT> can be either a user name or uid.  <TT>group</TT> can be either a group name or gid.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -r directory

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies a run-time directory.  slapd will chroot(2) to this directory after opening listeners but before reading any configuration files or initializing any backends.

cvsdist

cvsdist

cvsdist

cvsdist

        -d <level> | ?

cvsdist

7a16c4a

cvsdist

7a16c4a

This option sets the slapd 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 are

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 6.1: Debugging Levels</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Level

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

-1

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

enable all debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

no debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

trace function calls

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

debug packet handling

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

heavy trace debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

connection management

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print out packets sent and received

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

search filter processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

configuration file processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

access control list processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

stats log connections/operations/results

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

stats log entries sent

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print communication with shell backends

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

print entry parsing debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

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, <TT> -d 65</TT>).  Or, you can let slapd do the math, (e.g. <TT> -d 1 -d 64</TT>).  Consult <TT><ldap.h></TT> for more details.

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: slapd must have been compiled with <TT>-DLDAP_DEBUG</TT> defined for any debugging information beyond the two stats levels to be available.

cvsdist

7a16c4a

cvsdist

7a16c4a

6.2. Starting slapd

cvsdist

7a16c4a

In general, slapd is run like this:

cvsdist

7a16c4a

cvsdist

7a16c4a

        /usr/local/etc/libexec/slapd [<option>]*

cvsdist

7a16c4a

cvsdist

7a16c4a

where <TT>/usr/local/etc/libexec</TT> is determined by <TT>configure</TT> and <option> is one of the options described above (or in slapd(8)). Unless you have specified a debugging level (including level <TT>0</TT>), slapd will automatically fork and detach itself from its controlling terminal and run in the background.

cvsdist

7a16c4a

6.3. Stopping slapd

cvsdist

7a16c4a

To kill off slapd safely, you should give a command like this

cvsdist

7a16c4a

cvsdist

7a16c4a

        kill -INT `cat /usr/local/var/slapd.pid`

cvsdist

7a16c4a

cvsdist

7a16c4a

where <TT>/usr/local/var</TT> is determined by <TT>configure</TT>.

cvsdist

7a16c4a

Killing slapd by a more drastic method may cause information loss or database corruption.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

7. Database Creation and Maintenance Tools

cvsdist

7a16c4a

This section tells you how to create a slapd database from scratch, and how to do trouble shooting if you run into problems. There are two ways to create a database. First, you can create the database on-line using LDAP. With this method, you simply start up slapd and add entries using the LDAP client of your choice. This method is fine for relatively small databases (a few hundred or thousand entries, depending on your requirements). This method works for database types which support updates.

cvsdist

7a16c4a

The second method of database creation is to do it off-line using special utilities provided with slapd. This method is best if you have many thousands of entries to create, which would take an unacceptably long time using the LDAP method, or if you want to ensure the database is not accessed while it is being created. Note that not all database types support these utilitites.

cvsdist

7a16c4a

7.1. Creating a database over LDAP

cvsdist

7a16c4a

With this method, you use the LDAP client of your choice (e.g., the ldapadd(1)) to add entries, just like you would once the database is created.  You should be sure to set the following options in the configuration file before starting slapd(8).

cvsdist

7a16c4a

cvsdist

7a16c4a

        suffix <dn>

cvsdist

7a16c4a

cvsdist

7a16c4a

As described in the General Database Directives section, this option defines which entries are to be held by this database. You should set this to the DN of the root of the subtree you are trying to create.  For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        suffix "dc=example,dc=com"

cvsdist

7a16c4a

cvsdist

7a16c4a

You should be sure to specify a directory where the index files should be created:

cvsdist

7a16c4a

cvsdist

7a16c4a

        directory <directory>

cvsdist

7a16c4a

cvsdist

7a16c4a

For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        directory /usr/local/var/openldap-ldbm

cvsdist

7a16c4a

cvsdist

7a16c4a

You need to create this directory with appropriate permissions such that slapd can write to it.

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

        rootdn <dn>

cvsdist

7a16c4a

        rootpw <passwd>

cvsdist

7a16c4a

cvsdist

7a16c4a

For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        rootdn "cn=Manager,dc=example,dc=com"

cvsdist

7a16c4a

        rootpw secret

cvsdist

7a16c4a

cvsdist

7a16c4a

These options specify a DN and password that can be used to authenticate as the super-user entry of the database (i.e., the entry allowed to do anything). The DN and password specified here will always work, regardless of whether the entry named actually exists or has the password given. This solves the chicken-and-egg problem of how to authenticate and add entries before any entries yet exist.

cvsdist

7a16c4a

Finally, you should make sure that the database definition contains the index definitions you want:

cvsdist

7a16c4a

cvsdist

7a16c4a

        index {<attrlist> | default} [pres,eq,approx,sub,none]

cvsdist

7a16c4a

cvsdist

7a16c4a

For example, to index the <TT>cn</TT>, <TT>sn</TT>, <TT>uid</TT> and <TT>objectclass</TT> attributes, the following <TT>index</TT> directives could be used:

cvsdist

7a16c4a

cvsdist

7a16c4a

        index cn,sn,uid

cvsdist

7a16c4a

        index objectClass pres,eq

cvsdist

7a16c4a

cvsdist

7a16c4a

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 <TERM>LDIF</TERM> file called <TT>entries.ldif</TT> with the contents:

cvsdist

7a16c4a

cvsdist

7a16c4a

        # Organization for Example Corporation

cvsdist

7a16c4a

        dn: dc=example,dc=com

cvsdist

7a16c4a

        objectClass: dcObject

cvsdist

7a16c4a

        objectClass: organization

cvsdist

7a16c4a

        dc: example

cvsdist

7a16c4a

        o: Example Corporation

cvsdist

7a16c4a

        description: The Example Corporation

cvsdist

7a16c4a

cvsdist

7a16c4a

        # Organizational Role for Directory Manager

cvsdist

7a16c4a

        dn: cn=Manager,dc=example,dc=com

cvsdist

7a16c4a

        objectClass: organizationalRole

cvsdist

7a16c4a

        cn: Manager

cvsdist

7a16c4a

        description: Directory Manager

cvsdist

7a16c4a

cvsdist

7a16c4a

and then use a command like this to actually create the entry:

cvsdist

7a16c4a

cvsdist

7a16c4a

        ldapadd -f entries.ldif -x -D "cn=Manager,dc=example,dc=com" -w secret

cvsdist

7a16c4a

cvsdist

7a16c4a

The above command assumes settings provided in the above examples.

cvsdist

7a16c4a

7.2. Creating a database off-line

cvsdist

7a16c4a

The second method of database creation is to do it off-line, using the slapd database tools described below. This method is best if you have many thousands of entries to create, which would take an unacceptably long time to add using the LDAP method described above. These tools read the slapd configuration file and an input file containing a text representation of the entries to add. For database types which support the tools, they produce the database files directly (otherwise you must use the on-line method above). There are several important configuration options you will want to be sure and set in the config file database definition first:

cvsdist

7a16c4a

cvsdist

7a16c4a

        suffix <dn>

cvsdist

7a16c4a

cvsdist

7a16c4a

As described in the General Database Directives section, this option defines which entries are to be held by this database. You should set this to the DN of the root of the subtree you are trying to create.  For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        suffix "dc=example,dc=com"

cvsdist

7a16c4a

cvsdist

7a16c4a

You should be sure to specify a directory where the index files should be created:

cvsdist

7a16c4a

cvsdist

7a16c4a

        directory <directory>

cvsdist

7a16c4a

cvsdist

7a16c4a

For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        directory /usr/local/var/openldap-ldbm

cvsdist

7a16c4a

cvsdist

7a16c4a

Finally, you need to specify which indexes you want to build.  This is done by one or more index options.

cvsdist

7a16c4a

cvsdist

7a16c4a

        index {<attrlist> | default} [pres,eq,approx,sub,none]

cvsdist

7a16c4a

cvsdist

7a16c4a

For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        index cn,sn,uid pres,eq,approx

cvsdist

7a16c4a

        index objectClass eq

cvsdist

7a16c4a

cvsdist

7a16c4a

This would create presence, equality and approximate indexes for the <TT>cn</TT>, <TT>sn</TT>, and <TT>uid</TT> attributes and an equality index for the <TT>objectClass</TT> attribute. See the configuration file section for more information on this option.

cvsdist

7a16c4a

7.2.1. The <TT>slapadd</TT> program

cvsdist

7a16c4a

Once you've configured things to your liking, you create the primary database and associated indexes by running the slapadd(8) program:

cvsdist

7a16c4a

cvsdist

7a16c4a

        slapadd -l <inputfile> -f <slapdconfigfile>

cvsdist

7a16c4a

                [-d <debuglevel>] [-n <integer>|-b <suffix>]

cvsdist

7a16c4a

cvsdist

7a16c4a

The arguments have the following meanings:

cvsdist

7a16c4a

cvsdist

7a16c4a

        -l <inputfile>

cvsdist

7a16c4a

cvsdist

7a16c4a

Specifies the LDIF input file containing the entries to add in text form (described below in the The LDIF text entry format section).

cvsdist

7a16c4a

cvsdist

7a16c4a

        -f <slapdconfigfile>

cvsdist

7a16c4a

cvsdist

7a16c4a

Specifies the slapd configuration file that tells where to create the indexes, what indexes to create, etc.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -d <debuglevel>

cvsdist

7a16c4a

cvsdist

7a16c4a

Turn on debugging, as specified by <TT><debuglevel></TT>. The debug levels are the same as for slapd.  See the Command-Line Options section in Running slapd.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -n <databasenumber>

cvsdist

7a16c4a

cvsdist

7a16c4a

An optional argument that specifies which database to modify.  The first database listed in the configuration file is <TT>1</TT>, the second <TT>2</TT>, etc. By default, the first ldbm database in the configuration file is used. Should not be used in conjunction with <TT>-b</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -b <suffix>

cvsdist

7a16c4a

cvsdist

7a16c4a

An optional argument that specifies which database to modify.  The provided suffix is matched against a database <TT>suffix</TT> directive to determine the database number. Should not be used in conjunction with <TT>-n</TT>.

cvsdist

7a16c4a

7.2.2. The <TT>slapindex</TT> program

cvsdist

7a16c4a

Sometimes it may be necessary to regenerate indices (such as after modifying slapd.conf(5)). This is possible using the slapindex(8) program.  slapindex is invoked like this

cvsdist

7a16c4a

cvsdist

7a16c4a

        slapindex -f <slapdconfigfile>

cvsdist

7a16c4a

                [-d <debuglevel>] [-n <databasenumber>|-b <suffix>]

cvsdist

7a16c4a

cvsdist

7a16c4a

Where the <TT>-f</TT>, <TT>-d</TT>, <TT>-n</TT> and <TT>-b</TT> options are the same as for the slapadd(1) program.  slapindex rebuilds all indices based upon the current database contents.

cvsdist

7a16c4a

7.2.3. The <TT>slapcat</TT> program

cvsdist

7a16c4a

The <TT>slapcat</TT> program is used to dump the database to an <TERM>LDIF</TERM> file.  This can be useful when you want to make a human-readable backup of your database or when you want to edit your database off-line.  The program is invoked like this:

cvsdist

7a16c4a

cvsdist

7a16c4a

        slapcat -l <filename> -f <slapdconfigfile>

cvsdist

7a16c4a

                [-d <debuglevel>] [-n <databasenumber>|-b <suffix>]

cvsdist

7a16c4a

cvsdist

7a16c4a

where <TT>-n</TT> or <TT>-b</TT> is used to select the database in the slapd.conf(5) specified using <TT>-f</TT>.  The corresponding LDIF output is written to standard output or to the file specified using the <TT>-l</TT> option.

cvsdist

7a16c4a

7.3. The LDIF text entry format

cvsdist

7a16c4a

The <TERM>LDAP Data Interchange Format</TERM> (LDIF) is used to represent LDAP entries in a simple text format.  This section provides a brief description of the LDIF entry format which complements ldif(5) and the technical specification RFC2849.

cvsdist

7a16c4a

The basic form of an entry is:

cvsdist

7a16c4a

cvsdist

7a16c4a

        # comment

cvsdist

7a16c4a

        dn: <distinguished name>

cvsdist

7a16c4a

        <attrdesc>: <attrvalue>

cvsdist

7a16c4a

        <attrdesc>: <attrvalue>

cvsdist

7a16c4a

cvsdist

7a16c4a

...

cvsdist

7a16c4a

cvsdist

7a16c4a

Lines starting with a '<TT>#</TT>' character are comments.  An attribute description may be a simple attribute type like <TT>cn</TT> or <TT>objectClass</TT> or <TT>1.2.3</TT> (an <TERM>OID</TERM> associated with an attribute type) or may include options such as <TT>cn;lang_en_US</TT> or <TT>userCertificate;binary</TT>.

cvsdist

7a16c4a

A line may be continued by starting the next line with a single space or tab character.  For example:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dn: cn=Barbara J Jensen,dc=example,dc=

cvsdist

7a16c4a

com

cvsdist

7a16c4a

        cn: Barbara J

cvsdist

7a16c4a

          Jensen

cvsdist

7a16c4a

cvsdist

7a16c4a

is equivalent to:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dn: cn=Barbara J Jensen,dc=example,dc=com

cvsdist

7a16c4a

        cn: Barbara J Jensen

cvsdist

7a16c4a

cvsdist

7a16c4a

Multiple attribute values are specified on separate lines. e.g.,

cvsdist

7a16c4a

cvsdist

7a16c4a

        cn: Barbara J Jensen

cvsdist

7a16c4a

        cn: Babs Jensen

cvsdist

7a16c4a

cvsdist

7a16c4a

If an <TT><attrvalue></TT> contains non-printing characters or begins with a space, a colon ('<TT>:</TT>'), or a less than ('<TT><</TT>'), the <TT><attrdesc></TT> is followed by a double colon and the base64 encoding of the value.  For example, the value "<TT> begins with a space</TT>" would be encoded like this:

cvsdist

7a16c4a

cvsdist

7a16c4a

        cn:: IGJlZ2lucyB3aXRoIGEgc3BhY2U=

cvsdist

7a16c4a

cvsdist

7a16c4a

You can also specify a <TERM>URL</TERM> containing the attribute value. For example, the following specifies the <TT>jpegPhoto</TT> value should be obtained from the file <TT>/path/to/file.jpeg</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

        cn:< file:///path/to/file.jpeg

cvsdist

7a16c4a

cvsdist

7a16c4a

Multiple entries within the same LDIF file are separated by blank lines. Here's an example of an LDIF file containing three entries.

cvsdist

7a16c4a

cvsdist

7a16c4a

        # Barbara's Entry

cvsdist

7a16c4a

        dn: cn=Barbara J Jensen,dc=example,dc=com

cvsdist

7a16c4a

        cn: Barbara J Jensen

cvsdist

7a16c4a

        cn: Babs Jensen

cvsdist

7a16c4a

        objectClass: person

cvsdist

7a16c4a

        sn: Jensen

cvsdist

7a16c4a

cvsdist

7a16c4a

        # Bjorn's Entry

cvsdist

7a16c4a

        dn: cn=Bjorn J Jensen,dc=example,dc=com

cvsdist

7a16c4a

        cn: Bjorn J Jensen

cvsdist

7a16c4a

        cn: Bjorn Jensen

cvsdist

7a16c4a

        objectClass: person

cvsdist

7a16c4a

        sn: Jensen

cvsdist

7a16c4a

        # Base64 encoded JPEG photo

cvsdist

7a16c4a

        jpegPhoto:: /9j/4AAQSkZJRgABAAAAAQABAAD/2wBDABALD

cvsdist

7a16c4a

         A4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQ

cvsdist

7a16c4a

         ERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVG

cvsdist

7a16c4a

cvsdist

7a16c4a

        # Jennifer's Entry

cvsdist

7a16c4a

        dn: cn=Jennifer J Jensen,dc=example,dc=com

cvsdist

7a16c4a

        cn: Jennifer J Jensen

cvsdist

7a16c4a

        cn: Jennifer Jensen

cvsdist

7a16c4a

        objectClass: person

cvsdist

7a16c4a

        sn: Jensen

cvsdist

7a16c4a

        # JPEG photo from file

cvsdist

7a16c4a

        jpegPhoto:< file:///path/to/file.jpeg

cvsdist

7a16c4a

cvsdist

7a16c4a

Notice that the <TT>jpegPhoto</TT> in Bjorn's entry is base 64 encoded and the <TT>jpegPhoto</TT> in Jennifer's entry is obtained from the location indicated by the URL.

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: Trailing spaces are not trimmed from values in an LDIF file. Nor are multiple internal spaces compressed. If you don't want them in your data, don't put them there.

cvsdist

cvsdist

cvsdist

cvsdist

8. Schema Specification

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

8.1. Distributed Schema Files

cvsdist

7a16c4a

OpenLDAP is distributed with a set of schema specifications for your use.  Each set is defined in a file suitable for inclusion (using the <TT>include</TT> directive) in your slapd.conf(5) file.  These schema files are normally installed in the <TT>/usr/local/etc/openldap/schema</TT> directory.

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 6.1: Provided Schema Specifications</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

File

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>core.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

OpenLDAP core (required)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>cosine.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Cosine and Internet X.500 (useful)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>inetorgperson.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

InetOrgPerson (useful)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>misc.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Assorted (experimental)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>nadf.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

North American Directory Forum (FYI)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>nis.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Network Information Services (FYI)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>openldap.schema</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

OpenLDAP Project (experimental)

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

        # include schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/core.schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/cosine.schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/inetorgperson.schema

cvsdist

7a16c4a

cvsdist

7a16c4a

Additional files may be available.  Please consult the OpenLDAP FAQ (http://www.openldap.org/faq/).

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: You should not modify any of the schema items defined in provided files.

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2. Extending Schema

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

There are five steps to defining new schema:

cvsdist

7a16c4a

cvsdist

7a16c4a

obtain Object Identifer

cvsdist

7a16c4a

choose a name prefix

cvsdist

7a16c4a

create local schema file

cvsdist

7a16c4a

define custom attribute types (if necessary)

cvsdist

7a16c4a

define custom object classes

cvsdist

7a16c4a

8.2.1. Object Identifiers

cvsdist

7a16c4a

Each schema element is identified by a globally unique <TERM>Object Identifier</TERM> (OID).  OIDs are also used to identify other objects. They are commonly found in protocols described by <TERM>ASN.1</TERM>.  In particular, they are heavily used by the <TERM>Simple Network Management Protocol</TERM> (SNMP). As OIDs are hierarchical, your organization can obtain one OID and branch it as needed.  For example, if your organization were assigned OID <TT>1.1</TT>, you could branch the tree as follows:

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 6.2: Example OID hierarchy</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

OID

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Assignment

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Organization's OID

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.1</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

SNMP Elements

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.2</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

LDAP Elements

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.2.1</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

AttributeTypes

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.2.1.1</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

myAttribute

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.2.2</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ObjectClasses

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>1.1.2.2.1</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

myObjectClass

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

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).

cvsdist

7a16c4a

For more information about Object Identifers (and a listing service) see http://www.alvestrand.no/harald/objectid/.

cvsdist

7a16c4a

cvsdist

7a16c4a

Under no circumstances should you use a fictious OID!

cvsdist

7a16c4a

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 <TT>1.3.6.1.4.1.X</TT> were <TT>X</TT> is an integer.

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2.2. Name Prefix

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

In the examples below, we have choosen a short prefix '<TT>my</TT>' (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 '<TT>deFirm</TT>' (German company) or '<TT>comExample</TT>' (elements associated with organization associated with <TT>example.com</TT>).

cvsdist

7a16c4a

8.2.3. Local schema file

cvsdist

7a16c4a

The <TT>objectclass</TT> and <TT>attributeTypes</TT> 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 <TT>local.schema</TT> in <TT>/usr/local/etc/openldap/schema/local.schema</TT> and then include this file in your slapd.conf(5) file immediately after other schema <TT>include</TT> directives.

cvsdist

7a16c4a

cvsdist

7a16c4a

        # include schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/core.schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/cosine.schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/inetorgperson.schema

cvsdist

7a16c4a

        # include local schema

cvsdist

7a16c4a

        include /usr/local/etc/openldap/schema/local.schema

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2.4. Attribute Type Specification

cvsdist

7a16c4a

The attributetype directive is used to define a new attribute type.  The directive uses the same Attribute Type Description (as defined in RFC2252) used by the attributeTypes attribute found in the subschema subentry, e.g.:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attributetype <RFC2252 Attribute Type Description>

cvsdist

7a16c4a

cvsdist

7a16c4a

where Attribute Type Description is defined by the following <TERM>BNF</TERM>:

cvsdist

7a16c4a

cvsdist

7a16c4a

      AttributeTypeDescription = "(" whsp

cvsdist

7a16c4a

            numericoid whsp              ; AttributeType identifier

cvsdist

7a16c4a

          [ "NAME" qdescrs ]             ; name used in AttributeType

cvsdist

7a16c4a

          [ "DESC" qdstring ]            ; description

cvsdist

7a16c4a

          [ "OBSOLETE" whsp ]

cvsdist

7a16c4a

          [ "SUP" woid ]                 ; derived from this other

cvsdist

7a16c4a

                                         ; AttributeType

cvsdist

7a16c4a

          [ "EQUALITY" woid              ; Matching Rule name

cvsdist

7a16c4a

          [ "ORDERING" woid              ; Matching Rule name

cvsdist

7a16c4a

          [ "SUBSTR" woid ]              ; Matching Rule name

cvsdist

7a16c4a

          [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3

cvsdist

7a16c4a

          [ "SINGLE-VALUE" whsp ]        ; default multi-valued

cvsdist

7a16c4a

          [ "COLLECTIVE" whsp ]          ; default not collective

cvsdist

7a16c4a

          [ "NO-USER-MODIFICATION" whsp ]; default user modifiable

cvsdist

7a16c4a

          [ "USAGE" whsp AttributeUsage ]; default userApplications

cvsdist

7a16c4a

          whsp ")"

cvsdist

7a16c4a

cvsdist

7a16c4a

      AttributeUsage =

cvsdist

7a16c4a

          "userApplications"     /

cvsdist

7a16c4a

          "directoryOperation"   /

cvsdist

7a16c4a

          "distributedOperation" / ; DSA-shared

cvsdist

7a16c4a

          "dSAOperation"          ; DSA-specific, value depends on server

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

where whsp is a space ('<TT> </TT>'), numericoid is a globally unique OID in numeric form (e.g. <TT>1.2.3</TT>), qdescrs is one or more names, woid is either the name or OID, and noidlen is an optional length specifier (e.g <TT>{10</TT>}).

cvsdist

7a16c4a

For example, the attribute types <TT>name</TT> and <TT>cn</TT> are defined in <TT>core.schema</TT> as:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attributeType ( 2.5.4.41 NAME 'name'

cvsdist

7a16c4a

                EQUALITY caseIgnoreMatch

cvsdist

7a16c4a

                SUBSTR caseIgnoreSubstringsMatch

cvsdist

7a16c4a

                SYNTAX 1.3.6.1.4.1.1466.115.121.1.15{32768} )

cvsdist

7a16c4a

        attributeType ( 2.5.4.3 NAME

cvsdist

7a16c4a

                ( 'cn' $ 'commonName' ) SUP name )

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

The first attribute, <TT>name</TT>, has a syntax of <TT>directoryString</TT> (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.

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 6.3: Supported Syntaxes</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Name

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

OID

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>binary</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.5</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

BER/DER data

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>boolean</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.7</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

boolean value

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>distinguishedName</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.12</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

DN

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>directoryString</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.15</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

UTF-8 string

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>IA5String</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.26</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ASCII string

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>Integer</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.27</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

integer

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>Name and Optional UID</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.34</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

DN plus UID

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>Numeric String</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.36</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

numeric string

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>OID</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.38</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

object identifier

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>Octet String</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.40</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

arbitary octets

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>Printable String</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<TT>1.3.6.1.4.1.1466.115.121.1.44</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

printable string

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<CAPTION ALIGN=top>Table 6.4: Supported Matching Rules</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Name

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Type

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>booleanMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

boolean

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>objectIdentiferMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

OID

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>distinguishedNameMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

DN

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>uniqueMemberMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

DN with optional UID

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>numericStringMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

numerical

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>numericStringOrderingMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ordering

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

numerical

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>numericStringSubstringsMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

substrings

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

numerical

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreOrderingMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ordering

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreSubstringsMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

substrings

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactOrderingMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ordering

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactSubstringsMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

substrings

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreIA5Match</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreIA5OrderingMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ordering

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseIgnoreIA5SubstringsMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

substrings

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case insensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactIA5Match</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

equality

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactIA5OrderingMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

ordering

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>caseExactIA5SubstringsMatch</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

substrings

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

case sensitive, space insensitive

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

The second attribute, <TT>cn</TT>, is a subtype of <TT>name</TT> hence it inherits the syntax, matching rules, and usage of <TT>name</TT>. <TT>commonName</TT> is an alternative name.

cvsdist

7a16c4a

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 <TT>OBSOLETE</TT>.

cvsdist

7a16c4a

The following subsections provide a couple of examples.

cvsdist

7a16c4a

8.2.4.1. myUniqueName

cvsdist

7a16c4a

Many organizations maintain a single unique name for each user. Though one could use <TT>displayName</TT> (RFC2798), this attribute is really meant to be controlled by the user, not the organization.  We could just copy the definition of <TT>displayName</TT> from <TT>inetorgperson.schema</TT> and replace the OID, name, and description, e.g:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attributetype ( 1.1.2.1.1 NAME 'myUniqueName'

cvsdist

7a16c4a

                DESC 'unique name with my organization'

cvsdist

7a16c4a

                EQUALITY caseIgnoreMatch

cvsdist

7a16c4a

                SUBSTR caseIgnoreSubstringsMatch

cvsdist

7a16c4a

                SYNTAX 1.3.6.1.4.1.1466.115.121.1.15

cvsdist

7a16c4a

                SINGLE-VALUE )

cvsdist

7a16c4a

cvsdist

7a16c4a

However, if we want this name to be included in <TT>name</TT> assertions [e.g. <TT>(name=*Jane*)</TT>], the attribute could alternatively be defined as a subtype of <TT>name</TT>, e.g.:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attributetype ( 1.1.2.1.1 NAME 'myUniqueName'

cvsdist

7a16c4a

                DESC 'unique name with my organization'

cvsdist

7a16c4a

                SUP name )

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2.4.2. myPhoto

cvsdist

7a16c4a

Many organizations maintain a photo of each each user.  A <TT>myPhoto</TT> attribute type could be defined to hold a photo. Of course, one could use just use <TT>jpegPhoto</TT> (RFC2798) (or a subtype) to hold the photo.  However, you can only do this if the photo is in JPEG File Interchange Format. Alternatively, an attribute type which uses the Octet String syntax can be defined, e.g.:

cvsdist

7a16c4a

cvsdist

7a16c4a

        attributetype ( 1.1.2.1.2 NAME 'myPhoto'

cvsdist

7a16c4a

                DESC 'a photo (application defined format)'

cvsdist

7a16c4a

                SYNTAX 1.3.6.1.4.1.1466.115.121.1.40

cvsdist

7a16c4a

                SINGLE-VALUE )

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

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 <TERM>ASN.1</TERM> and use the <TT>;binary</TT> transfer option.

cvsdist

7a16c4a

Another alternative is for the attribute to hold a <TERM>URI</TERM> pointing to the photo.  You can model such an attribute after <TT>labeledURI</TT> (RFC2079).

cvsdist

7a16c4a

8.2.5. Object Class Specification

cvsdist

7a16c4a

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.:

cvsdist

7a16c4a

cvsdist

7a16c4a

        objectclass <RFC2252 Object Class Description>

cvsdist

7a16c4a

cvsdist

7a16c4a

where Object Class Description is defined by the following <TERM>BNF</TERM>:

cvsdist

7a16c4a

cvsdist

7a16c4a

        ObjectClassDescription = "(" whsp

cvsdist

7a16c4a

                numericoid whsp      ; ObjectClass identifier

cvsdist

7a16c4a

                [ "NAME" qdescrs ]

cvsdist

7a16c4a

                [ "DESC" qdstring ]

cvsdist

7a16c4a

                [ "OBSOLETE" whsp ]

cvsdist

7a16c4a

                [ "SUP" oids ]       ; Superior ObjectClasses

cvsdist

7a16c4a

                [ ( "ABSTRACT" / "STRUCTURAL" / "AUXILIARY" ) whsp ]

cvsdist

7a16c4a

                        ; default structural

cvsdist

7a16c4a

                [ "MUST" oids ]      ; AttributeTypes

cvsdist

7a16c4a

                [ "MAY" oids ]       ; AttributeTypes

cvsdist

7a16c4a

                whsp ")"

cvsdist

7a16c4a

cvsdist

7a16c4a

where whsp is a space ('<TT> </TT>'), numericoid is a globally unique OID in numeric form (e.g. <TT>1.2.3</TT>), qdescrs is one or more names, and oids is one or more names and/or OIDs.

cvsdist

7a16c4a

8.2.5.1. myPhotoObject

cvsdist

7a16c4a

To define an auxiliary object class which allows myPhoto to be added to any existing entry.

cvsdist

7a16c4a

cvsdist

7a16c4a

        objectclass ( 1.1.2.2.1 NAME 'myPhotoObject'

cvsdist

7a16c4a

                DESC 'mixin myPhoto'

cvsdist

7a16c4a

                AUXILIARY

cvsdist

7a16c4a

                MAY myPhoto )

cvsdist

7a16c4a

cvsdist

7a16c4a

8.2.5.2. myPerson

cvsdist

7a16c4a

If your organization would like have a private structural object class to instantiate users, you can subclass one of the existing person classes, such as <TT>inetOrgPerson</TT> (RFC2798), and add any additional attributes which you desire.

cvsdist

7a16c4a

cvsdist

7a16c4a

        objectclass ( 1.1.2.2.2 NAME 'myPerson'

cvsdist

7a16c4a

                DESC 'my person'

cvsdist

7a16c4a

                SUP inetOrgPerson

cvsdist

7a16c4a

                MUST ( 'myUniqueName' $ 'givenName' )

cvsdist

7a16c4a

                MAY 'myPhoto' )

cvsdist

7a16c4a

cvsdist

7a16c4a

The object class inherits the required/allowed attribute types of <TT>inetOrgPerson</TT> but requires <TT>myUniqueName</TT> and <TT>givenName</TT> and allows <TT>myPhoto</TT>.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

9. Constructing a Distributed Directory Service

cvsdist

7a16c4a

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).

cvsdist

7a16c4a

slapd supports subordinate and superior knowledge information.

cvsdist

7a16c4a

9.1. Subordinate Knowledge Information

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

A referral object has a structural object class of <TT>referral</TT> and has the same <TERM>Distinguished Name</TERM> as the delegated subtree.  Generally, the referral object will also provide the auxiliary object class <TT>extensibleObject</TT>. This allows the entry to contain appropriate <TERM>Relative Distinguished Name</TERM> values.  This is best demonstrated by example.

cvsdist

7a16c4a

If the server <TT>a.example.net</TT> holds <TT>dc=example,dc=net</TT> and wished to delegate the subtree <TT>ou=subtree,dc=example,dc=net</TT> to another server <TT>b.example.net</TT>, the following named referral object would be added to <TT>a.example.net</TT>:

cvsdist

7a16c4a

cvsdist

7a16c4a

        dn: dc=subtree,dc=example,dc=net

cvsdist

7a16c4a

        objectClass: referral

cvsdist

7a16c4a

        objectClass: extensibleObject

cvsdist

7a16c4a

        dc: subtree

cvsdist

7a16c4a

        ref: ldap://b.example.net/dc=subtree,dc=example,dc=net

cvsdist

7a16c4a

cvsdist

7a16c4a

The server uses this information to generate referrals and search continuations to subordinate servers.

cvsdist

7a16c4a

For those familiar with X.500, a named referral object is similar to an X.500 knowledge reference held in a subr <TERM>DSE</TERM>.

cvsdist

7a16c4a

9.2. Superior Knowledge Information

cvsdist

7a16c4a

Superior knowledge information may be specified using the <TT>referral</TT> directive.  The value is a list of <TERM>URI</TERM>s referring to superior directory services.  For servers without immediate superiors, such as for <TT>a.example.net</TT> 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).

cvsdist

7a16c4a

cvsdist

7a16c4a

        referral        ldap://root.openldap.org/

cvsdist

7a16c4a

cvsdist

7a16c4a

However, as <TT>a.example.net</TT> is the immediate superior to <TT>b.example.net</TT>, b.example.net would be configured as follows:

cvsdist

7a16c4a

cvsdist

7a16c4a

        referral        ldap://a.example.net/

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

For those familiar with X.500, this use of the <TT>ref</TT> attribute is similar to an X.500 knowledge reference held in a Supr <TERM>DSE</TERM>.

cvsdist

7a16c4a

9.3. The ManageDsaIT Control

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

        ldapmodify -M -f referral.ldif -x -D "cn=Manager,dc=example,dc=net" -W

cvsdist

7a16c4a

cvsdist

7a16c4a

or with ldapsearch(1):

cvsdist

7a16c4a

cvsdist

7a16c4a

        ldapsearch -M -b "dc=example,dc=net" -x "(objectclass=referral)" '*' ref

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: the <TT>ref</TT> attribute is operational and must be explicitly requested when desired in search results.

cvsdist

cvsdist

cvsdist

cvsdist

10. Replication with slurpd

cvsdist

7a16c4a

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.  <TERM>DNS</TERM> can be setup such that a lookup of <TT>ldap.example.com</TT> returns the <TERM>IP</TERM> 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.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

10.1. Overview

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

Sample replication scenario:

cvsdist

7a16c4a

cvsdist

7a16c4a

The LDAP client submits an LDAP modify operation to the slave slapd.

cvsdist

7a16c4a

The slave slapd returns a referral to the LDAP client referring the client to the master slapd.

cvsdist

7a16c4a

The LDAP client submits the LDAP modify operation to the master slapd.

cvsdist

7a16c4a

The master slapd performs the modify operation, writes out the change to its replication log file and returns a success code to the client.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

The slave slapd performs the modify operation and returns a success code to the slurpd process.

cvsdist

7a16c4a

10.2. Replication Logs

cvsdist

7a16c4a

When slapd is configured to generate a replication logfile, it writes out a file containing <TERM>LDIF</TERM> 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 (<TT>uid=bjensen</TT>) has replaced the <TT>description</TT> value.  The change is to be propagated to the slapd instance running on <TT>slave.example.net</TT> Changes to various operational attributes, such as <TT>modifiersName</TT> and <TT>modifyTimestamp</TT>, are included in the change record and will be propagated to the slave slapd.

cvsdist

7a16c4a

cvsdist

7a16c4a

        replica: slave.example.com:389

cvsdist

7a16c4a

        time: 809618633

cvsdist

7a16c4a

        dn: uid=bjensen,dc=example,dc=com

cvsdist

7a16c4a

        changetype: modify

cvsdist

7a16c4a

        replace: multiLineDescription

cvsdist

7a16c4a

        description: A dreamer...

cvsdist

7a16c4a

cvsdist

7a16c4a

        replace: modifiersName

cvsdist

7a16c4a

        modifiersName: uid=bjensen,dc=example,dc=com

cvsdist

7a16c4a

cvsdist

7a16c4a

        replace: modifyTimestamp

cvsdist

7a16c4a

        modifyTimestamp: 20000805073308Z

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

The modifications to <TT>modifiersName</TT> and <TT>modifyTimestamp</TT> operational attributes were added by the master slapd.

cvsdist

7a16c4a

10.3. Command-Line Options

cvsdist

7a16c4a

This section details commonly used slurpd(8) command-line options.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -d <level> | ?

cvsdist

7a16c4a

cvsdist

7a16c4a

This option sets the slurpd debug level to <TT> <level></TT>. 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

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 10.1: Debugging Levels</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Level

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Description

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

heavy trace debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

configuration file processing

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

enable all debugging

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Debugging levels are additive. That is, if you want heavy trace debugging and want to watch the config file being processed, you would set level to the sum of those two levels (in this case, 68).

cvsdist

7a16c4a

cvsdist

7a16c4a

        -f <filename>

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -r <filename>

cvsdist

7a16c4a

cvsdist

7a16c4a

This option specifies an alternate slapd replication log file. Under normal circumstances, slurpd reads the name of the slapd replication log file from the slapd configuration file. However, you can override this with the -r flag, to cause slurpd to process a different replication log file. See the Advanced slurpd Operation section for a discussion of how you might use this option.

cvsdist

7a16c4a

cvsdist

7a16c4a

-o

cvsdist

7a16c4a

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

        -t <directory>

cvsdist

7a16c4a

cvsdist

7a16c4a

Specify an alternate directory for slurpd's temporary copies of replication logs. The default location is /usr/tmp.

cvsdist

7a16c4a

10.4. Configuring slurpd and a slave slapd instance

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

10.4.1. Set up the master slapd

cvsdist

7a16c4a

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).

cvsdist

7a16c4a

cvsdist

7a16c4a

Add a <TT>replica</TT> directive for each replica. The <TT>binddn=</TT> parameter should match the <TT>updatedn</TT> 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 <TT>rootdn</TT>, or allowed access via <TT>access</TT> directives in the slave slapd configuration file).

cvsdist

7a16c4a

Add a <TT>replogfile</TT> directive, which tells slapd where to log changes. This file will be read by slurpd.

cvsdist

7a16c4a

10.4.2. Set up the slave slapd

cvsdist

7a16c4a

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:

cvsdist

7a16c4a

cvsdist

7a16c4a

Do not include a <TT>replica</TT> directive. While it is possible to create "chains" of replicas, in most cases this is inappropriate.

cvsdist

7a16c4a

Do not include a <TT>replogfile</TT> directive.

cvsdist

7a16c4a

Do include an <TT>updatedn</TT> line. The DN given should match the DN given in the <TT>binddn=</TT> parameter of the corresponding <TT>replica=</TT> directive in the master slapd config file.

cvsdist

7a16c4a

Make sure the DN given in the <TT>updatedn</TT> directive has permission to write the database (e.g., it is listed as <TT>rootdn</TT> or is allowed <TT>access</TT> by one or more access directives).

cvsdist

7a16c4a

Use the <TT>updateref</TT> directive to define the URL the slave should return if an update request is received.

cvsdist

7a16c4a

10.4.3. Shut down the master slapd

cvsdist

7a16c4a

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 <TT>kill -INT <pid></TT>, where <TT><pid></TT> is the process-id of the master slapd process.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

10.4.4. Copy the master slapd's database to the slave

cvsdist

7a16c4a

Copy the master's database(s) to the slave. For an <TERM>LDBM</TERM>-based database, you must copy all database files located in the database <TT>directory</TT> specified in slapd.conf(5).  Database files will have a different suffix depending on the underlying database package used. The current possibilities are

cvsdist

7a16c4a

cvsdist

7a16c4a

<CAPTION ALIGN=top>Table 10.2: Database File Suffixes</CAPTION>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Suffix

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Database

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>dbb</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Berkeley DB B-tree backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>dbh</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Berkeley DB hash backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

<TT>gdbm</TT>

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

GNU DBM backend

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

In general, you should copy each file found in the database <TT> directory</TT> unless you know it is not used by slapd(8).

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: The copy process assumes homogeneous servers with identically configured OpenLDAP installations.

cvsdist

7a16c4a

cvsdist

7a16c4a

10.4.5. Configure the master slapd for replication

cvsdist

7a16c4a

To configure slapd to generate a replication logfile, you add a "<TT> replica</TT>" configuration option to the master slapd's config file. For example, if we wish to propagate changes to the slapd instance running on host <TT>slave.example.com</TT>:

cvsdist

7a16c4a

cvsdist

7a16c4a

        replica host=slave.example.com:389

cvsdist

7a16c4a

                binddn="cn=Replicator,dc=example,dc=com"

cvsdist

7a16c4a

                bindmethod=simple credentials=secret

cvsdist

7a16c4a

cvsdist

7a16c4a

In this example, changes will be sent to port 389 (the standard LDAP port) on host slave.example.com. The slurpd process will bind to the slave slapd as "<TT>cn=Replicator,dc=example,dc=com</TT>" using simple authentication with password "<TT>secret</TT>".  Note that the DN given by the <TT>binddn=</TT> directive must exist in the slave slapd's database (or be the rootdn specified in the slapd config file) in order for the bind operation to succeed.  The DN should also be listed as the <TT>updatedn</TT> for the database in the slave's slapd.conf(5).

cvsdist

7a16c4a

cvsdist

7a16c4a

Note: The use of strong authentication and transport security is highly recommended.

cvsdist

7a16c4a

cvsdist

7a16c4a

10.4.6. Restart the master slapd and start the slave slapd

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

10.4.7. Start slurpd

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

        slurpd -f <masterslapdconfigfile>

cvsdist

7a16c4a

cvsdist

7a16c4a

10.5. Advanced slurpd Operation

cvsdist

7a16c4a

10.5.1. Replication errors

cvsdist

7a16c4a

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 "<TT>.rej</TT>" appended. For example, for a replica running on host <TT>slave.example.com</TT>, port 389, the reject file, if it exists, will be named

cvsdist

7a16c4a

cvsdist

7a16c4a

        /usr/local/var/openldap/replog.slave.example.com:389.rej

cvsdist

7a16c4a

cvsdist

7a16c4a

A sample rejection log entry follows:

cvsdist

7a16c4a

cvsdist

7a16c4a

        ERROR: No such attribute

cvsdist

7a16c4a

        replica: slave.example.com:389

cvsdist

7a16c4a

        time: 809618633

cvsdist

7a16c4a

        dn: uid=bjensen,dc=example,dc=com

cvsdist

7a16c4a

        changetype: modify

cvsdist

7a16c4a

        replace: description

cvsdist

7a16c4a

        description: A dreamer...

cvsdist

7a16c4a

cvsdist

7a16c4a

        replace: modifiersName

cvsdist

7a16c4a

        modifiersName: uid=bjensen,dc=example,dc=com

cvsdist

7a16c4a

cvsdist

7a16c4a

        replace: modifyTimestamp

cvsdist

7a16c4a

        modifyTimestamp: 20000805073308Z

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

Note that this is precisely the same format as the original replication log entry, but with an <TT>ERROR</TT> line prepended to the entry.

cvsdist

7a16c4a

10.5.2. One-shot mode and reject files

cvsdist

7a16c4a

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 <TT>ERROR</TT> lines at the beginning of replication log entries, so it's not necessary to edit them out before feeding it the rejection log.

cvsdist

7a16c4a

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 <TT>/usr/local/var/openldap/replog.slave.example.com:389</TT> and exit, use the command

cvsdist

7a16c4a

cvsdist

7a16c4a

        slurpd -r /usr/tmp/replog.slave.example.com:389 -o

cvsdist

cvsdist

cvsdist

cvsdist

A. Generic configure Instructions

cvsdist

7a16c4a

cvsdist

7a16c4a

Basic Installation

cvsdist

7a16c4a

==================

cvsdist

7a16c4a

cvsdist

7a16c4a

   These are generic installation instructions.

cvsdist

7a16c4a

cvsdist

7a16c4a

   The `configure' shell script attempts to guess correct values for

cvsdist

7a16c4a

various system-dependent variables used during compilation.  It uses

cvsdist

7a16c4a

those values to create a `Makefile' in each directory of the package.

cvsdist

7a16c4a

It may also create one or more `.h' files containing system-dependent

cvsdist

7a16c4a

definitions.  Finally, it creates a shell script `config.status' that

cvsdist

7a16c4a

you can run in the future to recreate the current configuration, a file

cvsdist

7a16c4a

`config.cache' that saves the results of its tests to speed up

cvsdist

7a16c4a

reconfiguring, and a file `config.log' containing compiler output

cvsdist

7a16c4a

(useful mainly for debugging `configure').

cvsdist

7a16c4a

cvsdist

7a16c4a

   If you need to do unusual things to compile the package, please try

cvsdist

7a16c4a

to figure out how `configure' could check whether to do them, and mail

cvsdist

7a16c4a

diffs or instructions to the address given in the `README' so they can

cvsdist

7a16c4a

be considered for the next release.  If at some point `config.cache'

cvsdist

7a16c4a

contains results you don't want to keep, you may remove or edit it.

cvsdist

7a16c4a

cvsdist

7a16c4a

   The file `configure.in' is used to create `configure' by a program

cvsdist

7a16c4a

called `autoconf'.  You only need `configure.in' if you want to change

cvsdist

7a16c4a

it or regenerate `configure' using a newer version of `autoconf'.

cvsdist

7a16c4a

cvsdist

7a16c4a

The simplest way to compile this package is:

cvsdist

7a16c4a

cvsdist

7a16c4a

  1. `cd' to the directory containing the package's source code and type

cvsdist

7a16c4a

     `./configure' to configure the package for your system.  If you're

cvsdist

7a16c4a

     using `csh' on an old version of System V, you might need to type

cvsdist

7a16c4a

     `sh ./configure' instead to prevent `csh' from trying to execute

cvsdist

7a16c4a

     `configure' itself.

cvsdist

7a16c4a

cvsdist

7a16c4a

     Running `configure' takes awhile.  While running, it prints some

cvsdist

7a16c4a

     messages telling which features it is checking for.

cvsdist

7a16c4a

cvsdist

7a16c4a

  2. Type `make' to compile the package.

cvsdist

7a16c4a

cvsdist

7a16c4a

  3. Optionally, type `make check' to run any self-tests that come with

cvsdist

7a16c4a

     the package.

cvsdist

7a16c4a

cvsdist

7a16c4a

  4. Type `make install' to install the programs and any data files and

cvsdist

7a16c4a

     documentation.

cvsdist

7a16c4a

cvsdist

7a16c4a

  5. You can remove the program binaries and object files from the

cvsdist

7a16c4a

     source code directory by typing `make clean'.  To also remove the

cvsdist

7a16c4a

     files that `configure' created (so you can compile the package for

cvsdist

7a16c4a

     a different kind of computer), type `make distclean'.  There is

cvsdist

7a16c4a

     also a `make maintainer-clean' target, but that is intended mainly

cvsdist

7a16c4a

     for the package's developers.  If you use it, you may have to get

cvsdist

7a16c4a

     all sorts of other programs in order to regenerate files that came

cvsdist

7a16c4a

     with the distribution.

cvsdist

7a16c4a

cvsdist

7a16c4a

Compilers and Options

cvsdist

7a16c4a

=====================

cvsdist

7a16c4a

cvsdist

7a16c4a

   Some systems require unusual options for compilation or linking that

cvsdist

7a16c4a

the `configure' script does not know about.  You can give `configure'

cvsdist

7a16c4a

initial values for variables by setting them in the environment.  Using

cvsdist

7a16c4a

a Bourne-compatible shell, you can do that on the command line like

cvsdist

7a16c4a

this:

cvsdist

7a16c4a

     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

cvsdist

7a16c4a

cvsdist

7a16c4a

Or on systems that have the `env' program, you can do it like this:

cvsdist

7a16c4a

     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

cvsdist

7a16c4a

cvsdist

7a16c4a

Compiling For Multiple Architectures

cvsdist

7a16c4a

====================================

cvsdist

7a16c4a

cvsdist

7a16c4a

   You can compile the package for more than one kind of computer at the

cvsdist

7a16c4a

same time, by placing the object files for each architecture in their

cvsdist

7a16c4a

own directory.  To do this, you must use a version of `make' that

cvsdist

7a16c4a

supports the `VPATH' variable, such as GNU `make'.  `cd' to the

cvsdist

7a16c4a

directory where you want the object files and executables to go and run

cvsdist

7a16c4a

the `configure' script.  `configure' automatically checks for the

cvsdist

7a16c4a

source code in the directory that `configure' is in and in `..'.

cvsdist

7a16c4a

cvsdist

7a16c4a

   If you have to use a `make' that does not supports the `VPATH'

cvsdist

7a16c4a

variable, you have to compile the package for one architecture at a time

cvsdist

7a16c4a

in the source code directory.  After you have installed the package for

cvsdist

7a16c4a

one architecture, use `make distclean' before reconfiguring for another

cvsdist

7a16c4a

architecture.

cvsdist

7a16c4a

cvsdist

7a16c4a

Installation Names

cvsdist

7a16c4a

==================

cvsdist

7a16c4a

cvsdist

7a16c4a

   By default, `make install' will install the package's files in

cvsdist

7a16c4a

`/usr/local/bin', `/usr/local/man', etc.  You can specify an

cvsdist

7a16c4a

installation prefix other than `/usr/local' by giving `configure' the

cvsdist

7a16c4a

option `--prefix=PATH'.

cvsdist

7a16c4a

cvsdist

7a16c4a

   You can specify separate installation prefixes for

cvsdist

7a16c4a

architecture-specific files and architecture-independent files.  If you

cvsdist

7a16c4a

give `configure' the option `--exec-prefix=PATH', the package will use

cvsdist

7a16c4a

PATH as the prefix for installing programs and libraries.

cvsdist

7a16c4a

Documentation and other data files will still use the regular prefix.

cvsdist

7a16c4a

cvsdist

7a16c4a

   In addition, if you use an unusual directory layout you can give

cvsdist

7a16c4a

options like `--bindir=PATH' to specify different values for particular

cvsdist

7a16c4a

kinds of files.  Run `configure --help' for a list of the directories

cvsdist

7a16c4a

you can set and what kinds of files go in them.

cvsdist

7a16c4a

cvsdist

7a16c4a

   If the package supports it, you can cause programs to be installed

cvsdist

7a16c4a

with an extra prefix or suffix on their names by giving `configure' the

cvsdist

7a16c4a

option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

cvsdist

7a16c4a

cvsdist

7a16c4a

Optional Features

cvsdist

7a16c4a

=================

cvsdist

7a16c4a

cvsdist

7a16c4a

   Some packages pay attention to `--enable-FEATURE' options to

cvsdist

7a16c4a

`configure', where FEATURE indicates an optional part of the package.

cvsdist

7a16c4a

They may also pay attention to `--with-PACKAGE' options, where PACKAGE

cvsdist

7a16c4a

is something like `gnu-as' or `x' (for the X Window System).  The

cvsdist

7a16c4a

`README' should mention any `--enable-' and `--with-' options that the

cvsdist

7a16c4a

package recognizes.

cvsdist

7a16c4a

cvsdist

7a16c4a

   For packages that use the X Window System, `configure' can usually

cvsdist

7a16c4a

find the X include and library files automatically, but if it doesn't,

cvsdist

7a16c4a

you can use the `configure' options `--x-includes=DIR' and

cvsdist

7a16c4a

`--x-libraries=DIR' to specify their locations.

cvsdist

7a16c4a

cvsdist

7a16c4a

Specifying the System Type

cvsdist

7a16c4a

==========================

cvsdist

7a16c4a

cvsdist

7a16c4a

   There may be some features `configure' can not figure out

cvsdist

7a16c4a

automatically, but needs to determine by the type of host the package

cvsdist

7a16c4a

will run on.  Usually `configure' can figure that out, but if it prints

cvsdist

7a16c4a

a message saying it can not guess the host type, give it the

cvsdist

7a16c4a

`--host=TYPE' option.  TYPE can either be a short name for the system

cvsdist

7a16c4a

type, such as `sun4', or a canonical name with three fields:

cvsdist

7a16c4a

     CPU-COMPANY-SYSTEM

cvsdist

7a16c4a

cvsdist

7a16c4a

See the file `config.sub' for the possible values of each field.  If

cvsdist

7a16c4a

`config.sub' isn't included in this package, then this package doesn't

cvsdist

7a16c4a

need to know the host type.

cvsdist

7a16c4a

cvsdist

7a16c4a

   If you are building compiler tools for cross-compiling, you can also

cvsdist

7a16c4a

use the `--target=TYPE' option to select the type of system they will

cvsdist

7a16c4a

produce code for and the `--build=TYPE' option to select the type of

cvsdist

7a16c4a

system on which you are compiling the package.

cvsdist

7a16c4a

cvsdist

7a16c4a

Sharing Defaults

cvsdist

7a16c4a

================

cvsdist

7a16c4a

cvsdist

7a16c4a

   If you want to set default values for `configure' scripts to share,

cvsdist

7a16c4a

you can create a site shell script called `config.site' that gives

cvsdist

7a16c4a

default values for variables like `CC', `cache_file', and `prefix'.

cvsdist

7a16c4a

`configure' looks for `PREFIX/share/config.site' if it exists, then

cvsdist

7a16c4a

`PREFIX/etc/config.site' if it exists.  Or, you can set the

cvsdist

7a16c4a

`CONFIG_SITE' environment variable to the location of the site script.

cvsdist

7a16c4a

A warning: not all `configure' scripts look for a site script.

cvsdist

7a16c4a

cvsdist

7a16c4a

Operation Controls

cvsdist

7a16c4a

==================

cvsdist

7a16c4a

cvsdist

7a16c4a

   `configure' recognizes the following options to control how it

cvsdist

7a16c4a

operates.

cvsdist

7a16c4a

cvsdist

7a16c4a

`--cache-file=FILE'

cvsdist

7a16c4a

     Use and save the results of the tests in FILE instead of

cvsdist

7a16c4a

     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for

cvsdist

7a16c4a

     debugging `configure'.

cvsdist

7a16c4a

cvsdist

7a16c4a

`--help'

cvsdist

7a16c4a

     Print a summary of the options to `configure', and exit.

cvsdist

7a16c4a

cvsdist

7a16c4a

`--quiet'

cvsdist

7a16c4a

`--silent'

cvsdist

7a16c4a

`-q'

cvsdist

7a16c4a

     Do not print messages saying which checks are being made.  To

cvsdist

7a16c4a

     suppress all normal output, redirect it to `/dev/null' (any error

cvsdist

7a16c4a

     messages will still be shown).

cvsdist

7a16c4a

cvsdist

7a16c4a

`--srcdir=DIR'

cvsdist

7a16c4a

     Look for the package's source code in directory DIR.  Usually

cvsdist

7a16c4a

     `configure' can determine that directory automatically.

cvsdist

7a16c4a

cvsdist

7a16c4a

`--version'

cvsdist

7a16c4a

     Print the version of Autoconf used to generate the `configure'

cvsdist

7a16c4a

     script, and exit.

cvsdist

7a16c4a

cvsdist

7a16c4a

`configure' also accepts some other, not widely useful, options.

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

B. OpenLDAP Software Copyright Notices

cvsdist

7a16c4a

B.1. OpenLDAP Copyright Notice

cvsdist

7a16c4a

Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA All rights reserved.

cvsdist

7a16c4a

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 <TT>LICENSE</TT> in the top-level directory of the distribution.

cvsdist

7a16c4a

Individual files and/or contributed packages may be copyright by other parties and their use subject to additional restrictions.

cvsdist

7a16c4a

This work is derived from the University of Michigan LDAP v3.3 distribution.  Information concerning this software is available at:

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.umich.edu/~dirsvcs/ldap/.

cvsdist

7a16c4a

This work also contains materials derived from public sources.

cvsdist

7a16c4a

Additional Information about OpenLDAP can be obtained at:

cvsdist

7a16c4a

cvsdist

7a16c4a

http://www.OpenLDAP.org/

cvsdist

7a16c4a

or by sending e-mail to:

cvsdist

7a16c4a

cvsdist

7a16c4a

info@OpenLDAP.org

cvsdist

7a16c4a

B.2. University of Michigan Copyright Notice

cvsdist

7a16c4a

Portions Copyright 1992-1996 Regents of the University of Michigan. All rights reserved.

cvsdist

7a16c4a

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.

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

C. The OpenLDAP Public License

cvsdist

7a16c4a

cvsdist

7a16c4a

The OpenLDAP Public License

cvsdist

7a16c4a

  Version 2.4, 8 December 2000

cvsdist

7a16c4a

cvsdist

7a16c4a

Redistribution and use of this software and associated documentation

cvsdist

7a16c4a

("Software"), with or without modification, are permitted provided

cvsdist

7a16c4a

that the following conditions are met:

cvsdist

7a16c4a

cvsdist

7a16c4a

1. Redistributions of source code must retain copyright statements

cvsdist

7a16c4a

and notices.

cvsdist

7a16c4a

cvsdist

7a16c4a

2. Redistributions in binary form must reproduce applicable copyright

cvsdist

7a16c4a

statements and notices, this list of conditions, and the following

cvsdist

7a16c4a

disclaimer in the documentation and/or other materials provided

cvsdist

7a16c4a

with the distribution.

cvsdist

7a16c4a

cvsdist

7a16c4a

3. Redistributions must contain a verbatim copy of this document.

cvsdist

7a16c4a

cvsdist

7a16c4a

4. The names and trademarks of the authors and copyright holders

cvsdist

7a16c4a

must not be used in advertising or otherwise to promote the sale,

cvsdist

7a16c4a

use or other dealing in this Software without specific, written

cvsdist

7a16c4a

prior permission.

cvsdist

7a16c4a

cvsdist

7a16c4a

5. Due credit should be given to the OpenLDAP Project.

cvsdist

7a16c4a

cvsdist

7a16c4a

6. The OpenLDAP Foundation may revise this license from time to

cvsdist

7a16c4a

time.  Each revision is distinguished by a version number.  You

cvsdist

7a16c4a

may use the Software under terms of this license revision or under

cvsdist

7a16c4a

the terms of any subsequent revision of the license.

cvsdist

7a16c4a

cvsdist

7a16c4a

THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND CONTRIBUTORS

cvsdist

7a16c4a

``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT

cvsdist

7a16c4a

NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

cvsdist

7a16c4a

FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL

cvsdist

7a16c4a

THE OPENLDAP FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY

cvsdist

7a16c4a

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

cvsdist

7a16c4a

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

cvsdist

7a16c4a

GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

cvsdist

7a16c4a

INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER

cvsdist

7a16c4a

IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

cvsdist

7a16c4a

OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN

cvsdist

7a16c4a

IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cvsdist

7a16c4a

cvsdist

7a16c4a

OpenLDAP is a trademark of the OpenLDAP Foundation.

cvsdist

7a16c4a

cvsdist

7a16c4a

Copyright 1999-2000 The OpenLDAP Foundation, Redwood City,

cvsdist

7a16c4a

California, USA.  All Rights Reserved.  Permission to copy and

cvsdist

7a16c4a

distributed verbatim copies of this document is granted.

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

cvsdist

Home | Catalog

cvsdist

7a16c4a

cvsdist

7a16c4a

cvsdist

7a16c4a

<FONT COLOR="#808080" FACE="Arial,Verdana,Helvetica" SIZE="1">

cvsdist

7a16c4a

______________

cvsdist

7a16c4a

<SMALL>© Copyright 2000, OpenLDAP Foundation, info@OpenLDAP.org</SMALL></FONT>

cvsdist

cvsdist

cvsdist

cvsdist

</BODY>

cvsdist

7a16c4a

</HTML>

mhonek / rpms / openldap

Source Code

Blame guide.html

OpenLDAP 2.0 Administrator's Guide

Table of Contents

Copyright

Scope of this Document

Acknowledgments

Amendments

About this document

5.2.1.2. attributetype <RFC2252 Attribute Type Description>

5.2.1.7. objectclass <RFC2252 Object Class Description>