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

   1 .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2017 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 URLs 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 .LP
  96 LDAP controls to be passed to routines can be manipulated using the
  97 .BR ldap_controls (3)
  98 routines.
  99 .SH DISPLAYING RESULTS
 100 Results obtained from the search routines can be output by hand,
 101 by calling
 102 .BR ldap_first_entry (3)
 103 and
 104 .BR ldap_next_entry (3)
 105 to step through
 106 the entries returned,
 107 .BR ldap_first_attribute (3)
 108 and
 109 .BR ldap_next_attribute (3)
 110 to step through an entry's attributes, and
 111 .BR ldap_get_values (3)
 112 to retrieve a given attribute's values.  Attribute values
 113 may or may not be displayable.
 114 .SH UTILITY ROUTINES
 115 Also provided are various utility routines.  The
 116 .BR ldap_sort (3)
 117 routines are used to sort the entries and values returned via
 118 the ldap search routines.
 119 .SH DEPRECATED INTERFACES
 120 A number of interfaces are now considered deprecated.  For instance,
 121 ldap_add(3) is deprecated in favor of ldap_add_ext(3).
 122 .so Deprecated
 123 .SH BER LIBRARY
 124 Also included in the distribution is a set of lightweight Basic
 125 Encoding Rules routines.  These routines are used by the LDAP library
 126 routines to encode and decode LDAP protocol elements using the
 127 (slightly simplified) Basic Encoding Rules defined by LDAP.  They are
 128 not normally used directly by an LDAP application program except
 129 in the handling of controls and extended operations.  The
 130 routines provide a printf and scanf\-like interface, as well as
 131 lower\-level access.  These routines are discussed in
 132 .BR lber\-decode (3),
 133 .BR lber\-encode (3),
 134 .BR lber\-memory (3),
 135 and
 136 .BR lber\-types (3).
 137 .SH INDEX
 138 .TP 20
 139 .SM ldap_initialize(3)
 140 initialize the LDAP library without opening a connection to a server
 141 .TP
 142 .SM ldap_result(3)
 143 wait for the result from an asynchronous operation
 144 .TP
 145 .SM ldap_abandon_ext(3)
 146 abandon (abort) an asynchronous operation
 147 .TP
 148 .SM ldap_add_ext(3)
 149 asynchronously add an entry
 150 .TP
 151 .SM ldap_add_ext_s(3)
 152 synchronously add an entry
 153 .TP
 154 .SM ldap_sasl_bind(3)
 155 asynchronously bind to the directory
 156 .TP
 157 .SM ldap_sasl_bind_s(3)
 158 synchronously bind to the directory
 159 .TP
 160 .SM ldap_unbind_ext(3)
 161 synchronously unbind from the LDAP server and close the connection
 162 .TP
 163 .SM ldap_unbind(3) and ldap_unbind_s(3) are
 164 equivalent to
 165 .BR ldap_unbind_ext (3)
 166 .TP
 167 .SM ldap_memfree(3)
 168 dispose of memory allocated by LDAP routines.
 169 .TP
 170 .SM ldap_compare_ext(3)
 171 asynchronously compare to a directory entry
 172 .TP
 173 .SM ldap_compare_ext_s(3)
 174 synchronously compare to a directory entry
 175 .TP
 176 .SM ldap_delete_ext(3)
 177 asynchronously delete an entry
 178 .TP
 179 .SM ldap_delete_ext_s(3)
 180 synchronously delete an entry
 181 .TP
 182 .SM ld_errno(3)
 183 LDAP error indication
 184 .TP
 185 .SM ldap_errlist(3)
 186 list of LDAP errors and their meanings
 187 .TP
 188 .SM ldap_err2string(3)
 189 convert LDAP error indication to a string
 190 .TP
 191 .SM ldap_extended_operation(3)
 192 asynchronously perform an arbitrary extended operation
 193 .TP
 194 .SM ldap_extended_operation_s(3)
 195 synchronously perform an arbitrary extended operation
 196 .TP
 197 .SM ldap_first_attribute(3)
 198 return first attribute name in an entry
 199 .TP
 200 .SM ldap_next_attribute(3)
 201 return next attribute name in an entry
 202 .TP
 203 .SM ldap_first_entry(3)
 204 return first entry in a chain of search results
 205 .TP
 206 .SM ldap_next_entry(3)
 207 return next entry in a chain of search results
 208 .TP
 209 .SM ldap_count_entries(3)
 210 return number of entries in a search result
 211 .TP
 212 .SM ldap_get_dn(3)
 213 extract the DN from an entry
 214 .TP
 215 .SM ldap_get_values_len(3)
 216 return an attribute's values with lengths
 217 .TP
 218 .SM ldap_value_free_len(3)
 219 free memory allocated by ldap_get_values_len(3)
 220 .TP
 221 .SM ldap_count_values_len(3)
 222 return number of values
 223 .TP
 224 .SM ldap_modify_ext(3)
 225 asynchronously modify an entry
 226 .TP
 227 .SM ldap_modify_ext_s(3)
 228 synchronously modify an entry
 229 .TP
 230 .SM ldap_mods_free(3)
 231 free array of pointers to mod structures used by ldap_modify_ext(3)
 232 .TP
 233 .SM ldap_rename(3)
 234 asynchronously rename an entry
 235 .TP
 236 .SM ldap_rename_s(3)
 237 synchronously rename an entry
 238 .TP
 239 .SM ldap_msgfree(3)
 240 free results allocated by ldap_result(3)
 241 .TP
 242 .SM ldap_msgtype(3)
 243 return the message type of a message from ldap_result(3)
 244 .TP
 245 .SM ldap_msgid(3)
 246 return the message id of a message from ldap_result(3)
 247 .TP
 248 .SM ldap_search_ext(3)
 249 asynchronously search the directory
 250 .TP
 251 .SM ldap_search_ext_s(3)
 252 synchronously search the directory
 253 .TP
 254 .SM ldap_is_ldap_url(3)
 255 check a URL string to see if it is an LDAP URL
 256 .TP
 257 .SM ldap_url_parse(3)
 258 break up an LDAP URL string into its components
 259 .TP
 260 .SM ldap_sort_entries(3)
 261 sort a list of search results
 262 .TP
 263 .SM ldap_sort_values(3)
 264 sort a list of attribute values
 265 .TP
 266 .SM ldap_sort_strcasecmp(3)
 267 case insensitive string comparison
 268 .SH SEE ALSO
 269 .BR ldap.conf (5),
 270 .BR slapd (8),
 271 .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
 272 .SH ACKNOWLEDGEMENTS
 273 .so ../Project
 274 .LP
 275 These API manual pages are loosely based upon descriptions provided
 276 in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work
 277 in progress.
 278