git.sur5r.net Git - openldap/blob - doc/man/man3/ldap.3

   1 .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap - OpenLDAP Lightweight Directory Access Protocol API
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, -lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .ft B
  12 #include <ldap.h>
  13 .ft
  14 .fi
  15 .SH DESCRIPTION
  16 .LP
  17 The Lightweight Directory Access Protocol (LDAP) (RFC 4510) provides
  18 access to X.500 directory services.  These services may be stand\-alone
  19 or part of a distributed directory service.  This client API supports
  20 LDAP over TCP (RFC 4511), LDAP over TLS/SSL, and LDAP over IPC (UNIX
  21 domain sockets).  This API supports SASL (RFC 4513) and Start TLS
  22 (RFC 4513) as well as a number of protocol extensions.  This API is
  23 loosely based upon IETF/LDAPEXT C LDAP API draft specification, a (orphaned)
  24 work in progress.
  25 .LP
  26 The OpenLDAP Software package includes a stand\-alone server in
  27 .BR slapd (8),
  28 various LDAP clients, and an LDAP client library used to provide
  29 programmatic access to the LDAP protocol. This man page gives an
  30 overview of the LDAP library routines.
  31 .LP
  32 Both synchronous and asynchronous APIs are provided.  Also included are
  33 various routines to parse the results returned from these routines.
  34 These routines are found in the \-lldap library.
  35 .LP
  36 The basic interaction is as follows.  A session handle is
  37 created using
  38 .BR ldap_initialize (3)
  39 and set the protocol version to 3 by calling
  40 .BR ldap_set_option (3).
  41 The underlying session is established first operation is
  42 issued.  This would generally be a Start TLS or Bind operation,
  43 or a Search operation to read attributes of the Root DSE.
  44 A Start TLS operation is performed by calling
  45 .BR ldap_start_tls_s (3).
  46 A LDAP bind operation is performed by calling
  47 .BR ldap_sasl_bind (3)
  48 or one of its friends.
  49 A Search operation is performed by calling ldap_search_ext_s(3)
  50 or one of its friends.
  51
  52 Subsequently, additional operations are performed
  53 by calling one of the synchronous or asynchronous routines (e.g.,
  54 .BR ldap_compare_ext_s (3)
  55 or
  56 .BR ldap_compare_ext (3)
  57 followed by
  58 .BR ldap_result (3)).
  59 Results returned from these routines are interpreted by calling the
  60 LDAP parsing routines such as
  61 .BR ldap_parse_result (3).
  62 The LDAP association and underlying connection is terminated by calling
  63 .BR ldap_unbind_ext (3).
  64 Errors can be interpreted by calling
  65 .BR ldap_err2string (3).
  66 .SH LDAP versions
  67 This library supports version 3 of the Lightweight Directory Access
  68 Protocol (LDAPv3) as defined in RFC 4510.  It also supports a variant
  69 of version 2 of LDAP as defined by U-Mich LDAP and, to some degree,
  70 RFC 1777.  Version 2 (all variants) are considered obsolete.
  71 Version 3 should be used instead.
  72 .LP
  73 For backwards compatibility reasons, the library defaults to version 2.
  74 Hence, all new applications (and all actively maintained applications)
  75 should use
  76 .BR ldap_set_option (3)
  77 to select version 3.  The library manual pages assume version 3
  78 has been selected.
  79 .SH INPUT and OUTPUT PARAMETERS
  80 All character string input/output is expected to be/is UTF\-8
  81 encoded Unicode (version 3.2).
  82 .LP
  83 Distinguished names (DN) (and relative distinguished names (RDN) to
  84 be passed to the LDAP routines should conform to RFC 4514 UTF\-8
  85 string representation.
  86 .LP
  87 Search filters to be passed to the search routines are to be
  88 constructed by hand and should conform to RFC 4515 UTF\-8
  89 string representation.
  90 .LP
  91 LDAP URL are to be passed to routines are expected to conform
  92 to RFC 4516 format.  The
  93 .BR ldap_url (3)
  94 routines can be used to work with LDAP URLs.
  95 .SH DISPLAYING RESULTS
  96 Results obtained from the search routines can be output by hand,
  97 by calling
  98 .BR ldap_first_entry (3)
  99 and
 100 .BR ldap_next_entry (3)
 101 to step through
 102 the entries returned,
 103 .BR ldap_first_attribute (3)
 104 and
 105 .BR ldap_next_attribute (3)
 106 to step through an entry's attributes, and
 107 .BR ldap_get_values (3)
 108 to retrieve a given attribute's values.  Attribute values
 109 may or may not be displayable.
 110 .SH UTILITY ROUTINES
 111 Also provided are various utility routines.  The
 112 .BR ldap_sort (3)
 113 routines are used to sort the entries and values returned via
 114 the ldap search routines.
 115 .SH DEPRECATED INTERFACES
 116 A number of interfaces are now considered deprecated.  For instance,
 117 ldap_add(3) is deprecated in favor of ldap_add_ext(3).  While deprecated,
 118 these interfaces generally remain in the library.  The macro
 119 LDAP_DEPRECATED can be defined to a non-zero value
 120 (e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use
 121 deprecated interaces.  It is recommended that developers writing new
 122 programs, or updating old programs, avoid use of deprecated interfaces.
 123 Over time, it is expected that documentation (and, eventually, support) for
 124 deprecated interfaces to be eliminated.
 125 .SH BER LIBRARY
 126 Also included in the distribution is a set of lightweight Basic
 127 Encoding Rules routines.  These routines are used by the LDAP library
 128 routines to encode and decode LDAP protocol elements using the
 129 (slightly simplified) Basic Encoding Rules defined by LDAP.  They are
 130 not normally used directly by an LDAP application program except
 131 in the handling of controls and extended operations.  The
 132 routines provide a printf and scanf\-like interface, as well as
 133 lower\-level access.  These routines are discussed in
 134 .BR lber\-decode (3),
 135 .BR lber\-encode (3),
 136 .BR lber\-memory (3),
 137 and
 138 .BR lber\-types (3).
 139 .SH INDEX
 140 .TP 20
 141 .SM ldap_initialize(3)
 142 initialize the LDAP library without opening a connection to a server
 143 .TP
 144 .SM ldap_result(3)
 145 wait for the result from an asynchronous operation
 146 .TP
 147 .SM ldap_abandon_ext(3)
 148 abandon (abort) an asynchronous operation
 149 .TP
 150 .SM ldap_add_ext(3)
 151 asynchronously add an entry
 152 .TP
 153 .SM ldap_add_ext_s(3)
 154 synchronously add an entry
 155 .TP
 156 .SM ldap_sasl_bind(3)
 157 asynchronously bind to the directory
 158 .TP
 159 .SM ldap_sasl_bind_s(3)
 160 synchronously bind to the directory
 161 .TP
 162 .SM ldap_unbind_ext(3)
 163 synchronously unbind from the LDAP server and close the connection
 164 .TP
 165 .SM ldap_unbind(3) and ldap_unbind_s(3) are
 166 equivalent to
 167 .BR ldap_unbind_ext (3)
 168 .TP
 169 .SM ldap_memfree(3)
 170 dispose of memory allocated by LDAP routines.
 171 .TP
 172 .SM ldap_compare_ext(3)
 173 asynchronously compare to a directory entry
 174 .TP
 175 .SM ldap_compare_ext_s(3)
 176 synchronously compare to a directory entry
 177 .TP
 178 .SM ldap_delete_ext(3)
 179 asynchronously delete an entry
 180 .TP
 181 .SM ldap_delete_ext_s(3)
 182 synchronously delete an entry
 183 .TP
 184 .SM ld_errno(3)
 185 LDAP error indication
 186 .TP
 187 .SM ldap_errlist(3)
 188 list of LDAP errors and their meanings
 189 .TP
 190 .SM ldap_err2string(3)
 191 convert LDAP error indication to a string
 192 .TP
 193 .SM ldap_first_attribute(3)
 194 return first attribute name in an entry
 195 .TP
 196 .SM ldap_next_attribute(3)
 197 return next attribute name in an entry
 198 .TP
 199 .SM ldap_first_entry(3)
 200 return first entry in a chain of search results
 201 .TP
 202 .SM ldap_next_entry(3)
 203 return next entry in a chain of search results
 204 .TP
 205 .SM ldap_count_entries(3)
 206 return number of entries in a search result
 207 .TP
 208 .SM ldap_get_dn(3)
 209 extract the DN from an entry
 210 .TP
 211 .SM ldap_get_values_len(3)
 212 return an attribute's values with lengths
 213 .TP
 214 .SM ldap_value_free_len(3)
 215 free memory allocated by ldap_get_values_len(3)
 216 .TP
 217 .SM ldap_count_values_len(3)
 218 return number of values
 219 .TP
 220 .SM ldap_modify_ext(3)
 221 asynchronously modify an entry
 222 .TP
 223 .SM ldap_modify_ext_s(3)
 224 synchronously modify an entry
 225 .TP
 226 .SM ldap_mods_free(3)
 227 free array of pointers to mod structures used by ldap_modify_ext(3)
 228 .TP
 229 .SM ldap_rename(3)
 230 asynchronously rename an entry
 231 .TP
 232 .SM ldap_rename_s(3)
 233 synchronously rename an entry
 234 .TP
 235 .SM ldap_msgfree(3)
 236 free results allocated by ldap_result(3)
 237 .TP
 238 .SM ldap_msgtype(3)
 239 return the message type of a message from ldap_result(3)
 240 .TP
 241 .SM ldap_msgid(3)
 242 return the message id of a message from ldap_result(3)
 243 .TP
 244 .SM ldap_search_ext(3)
 245 asynchronously search the directory
 246 .TP
 247 .SM ldap_search_ext_s(3)
 248 synchronously search the directory
 249 .TP
 250 .SM ldap_is_ldap_url(3)
 251 check a URL string to see if it is an LDAP URL
 252 .TP
 253 .SM ldap_url_parse(3)
 254 break up an LDAP URL string into its components
 255 .TP
 256 .SM ldap_sort_entries(3)
 257 sort a list of search results
 258 .TP
 259 .SM ldap_sort_values(3)
 260 sort a list of attribute values
 261 .TP
 262 .SM ldap_sort_strcasecmp(3)
 263 case insensitive string comparison
 264 .SH SEE ALSO
 265 .BR ldap.conf (5),
 266 .BR slapd (8),
 267 .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
 268 .SH ACKNOWLEDGEMENTS
 269 .B OpenLDAP
 270 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 271 .B OpenLDAP
 272 is derived from University of Michigan LDAP 3.3 Release.
 273 .LP
 274 These API manual pages are loosely based upon descriptions provided
 275 in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work
 276 in progress.
 277