Section: C Library Functions (3)
Return to Main Contents
ldap - OpenLDAP Lightweight Directory Access Protocol API
OpenLDAP LDAP (libldap, -lldap)
The Lightweight Directory Access Protocol (LDAP) (RFC 4510) provides
access to X.500 directory services. These services may be stand-alone
or part of a distributed directory service. This client API supports
LDAP over TCP (RFC 4511), LDAP over TLS/SSL, and LDAP over IPC (UNIX
domain sockets). This API supports SASL (RFC 4513) and Start TLS
(RFC 4513) as well as a number of protocol extensions. This API is
loosely based upon IETF/LDAPEXT C LDAP API draft specification, a (orphaned)
work in progress.
The OpenLDAP Software package includes a stand-alone server in
various LDAP clients, and an LDAP client library used to provide
programmatic access to the LDAP protocol. This man page gives an
overview of the LDAP library routines.
Both synchronous and asynchronous APIs are provided. Also included are
various routines to parse the results returned from these routines.
These routines are found in the -lldap library.
The basic interaction is as follows. A session handle is
and set the protocol version to 3 by calling
The underlying session is established first operation is
issued. This would generally be a Start TLS or Bind operation,
or a Search operation to read attributes of the Root DSE.
A Start TLS operation is performed by calling
A LDAP bind operation is performed by calling
or one of its friends.
A Search operation is performed by calling ldap_search_ext_s(3)
or one of its friends.
Subsequently, additional operations are performed
by calling one of the synchronous or asynchronous routines (e.g.,
Results returned from these routines are interpreted by calling the
LDAP parsing routines such as
The LDAP association and underlying connection is terminated by calling
Errors can be interpreted by calling
This library supports version 3 of the Lightweight Directory Access
Protocol (LDAPv3) as defined in RFC 4510. It also supports a variant
of version 2 of LDAP as defined by U-Mich LDAP and, to some degree,
RFC 1777. Version 2 (all variants) are considered obsolete.
Version 3 should be used instead.
For backwards compatibility reasons, the library defaults to version 2.
Hence, all new applications (and all actively maintained applications)
to select version 3. The library manual pages assume version 3
has been selected.
INPUT and OUTPUT PARAMETERS
All character string input/output is expected to be/is UTF-8
encoded Unicode (version 3.2).
Distinguished names (DN) (and relative distinguished names (RDN) to
be passed to the LDAP routines should conform to RFC 4514 UTF-8
Search filters to be passed to the search routines are to be
constructed by hand and should conform to RFC 4515 UTF-8
LDAP URLs to be passed to routines are expected to conform
to RFC 4516 format. The
routines can be used to work with LDAP URLs.
LDAP controls to be passed to routines can be manipulated using the
Results obtained from the search routines can be output by hand,
to step through
the entries returned,
to step through an entry's attributes, and
to retrieve a given attribute's values. Attribute values
may or may not be displayable.
Also provided are various utility routines. The
routines are used to sort the entries and values returned via
the ldap search routines.
A number of interfaces are now considered deprecated. For instance,
(3) is deprecated in favor of ldap_add_ext
Deprecated interfaces generally remain in the library. The macro
LDAP_DEPRECATED can be defined to a non-zero value
(e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use
deprecated interfaces. It is recommended that developers writing new
programs, or updating old programs, avoid use of deprecated interfaces.
Over time, it is expected that documentation (and, eventually, support) for
deprecated interfaces to be eliminated.
Also included in the distribution is a set of lightweight Basic
Encoding Rules routines. These routines are used by the LDAP library
routines to encode and decode LDAP protocol elements using the
(slightly simplified) Basic Encoding Rules defined by LDAP. They are
not normally used directly by an LDAP application program except
in the handling of controls and extended operations. The
routines provide a printf and scanf-like interface, as well as
lower-level access. These routines are discussed in
initialize the LDAP library without opening a connection to a server
wait for the result from an asynchronous operation
abandon (abort) an asynchronous operation
asynchronously add an entry
synchronously add an entry
asynchronously bind to the directory
synchronously bind to the directory
synchronously unbind from the LDAP server and close the connection
- ldap_unbind(3) and ldap_unbind_s(3) are
dispose of memory allocated by LDAP routines.
asynchronously compare to a directory entry
synchronously compare to a directory entry
asynchronously delete an entry
synchronously delete an entry
LDAP error indication
list of LDAP errors and their meanings
convert LDAP error indication to a string
asynchronously perform an arbitrary extended operation
synchronously perform an arbitrary extended operation
return first attribute name in an entry
return next attribute name in an entry
return first entry in a chain of search results
return next entry in a chain of search results
return number of entries in a search result
extract the DN from an entry
return an attribute's values with lengths
free memory allocated by ldap_get_values_len(3)
return number of values
asynchronously modify an entry
synchronously modify an entry
free array of pointers to mod structures used by ldap_modify_ext(3)
asynchronously rename an entry
synchronously rename an entry
free results allocated by ldap_result(3)
return the message type of a message from ldap_result(3)
return the message id of a message from ldap_result(3)
asynchronously search the directory
synchronously search the directory
check a URL string to see if it is an LDAP URL
break up an LDAP URL string into its components
sort a list of search results
sort a list of attribute values
case insensitive string comparison
is developed and maintained by The OpenLDAP Project <http://www.openldap.org/
is derived from University of Michigan LDAP 3.3 Release.
These API manual pages are loosely based upon descriptions provided
in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work
- LDAP versions
- INPUT and OUTPUT PARAMETERS
- DISPLAYING RESULTS
- UTILITY ROUTINES
- DEPRECATED INTERFACES
- BER LIBRARY
- SEE ALSO