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 3377) 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 (RFC2251), LDAP over TLS/SSL, and LDAP over IPC (UNIX
  21 domain sockets).  This API supports SASL (RFC2829) and Start TLS
  22 (RFC2830) 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 3377.  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) should be viewed as 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 2253 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 2254 UTF\-8
  89 string representation.
  90 .LP
  91 LDAP URL are to be passed to routines are expected to conform
  92 to RFC 2255 syntax.  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 BER LIBRARY
 116 Also included in the distribution is a set of lightweight Basic
 117 Encoding Rules routines.  These routines are used by the LDAP library
 118 routines to encode and decode LDAP protocol elements using the
 119 (slightly simplified) Basic Encoding Rules defined by LDAP.  They are
 120 not normally used directly by an LDAP application program except
 121 in the handling of controls and extended operations.  The
 122 routines provide a printf and scanf\-like interface, as well as
 123 lower\-level access.  These routines are discussed in
 124 .BR lber\-decode (3),
 125 .BR lber\-encode (3),
 126 .BR lber\-memory (3),
 127 and
 128 .BR lber\-types (3).
 129 .SH INDEX
 130 .TP 20
 131 .SM ldap_initialize(3)
 132 initialize the LDAP library without opening a connection to a server
 133 .TP
 134 .SM ldap_result(3)
 135 wait for the result from an asynchronous operation
 136 .TP
 137 .SM ldap_abandon_ext(3)
 138 abandon (abort) an asynchronous operation
 139 .TP
 140 .SM ldap_add_ext(3)
 141 asynchronously add an entry
 142 .TP
 143 .SM ldap_add_ext_s(3)
 144 synchronously add an entry
 145 .TP
 146 .SM ldap_sasl_bind(3)
 147 asynchronously bind to the directory
 148 .TP
 149 .SM ldap_sasl_bind_s(3)
 150 synchronously bind to the directory
 151 .TP
 152 .SM ldap_unbind_ext(3)
 153 synchronously unbind from the LDAP server and close the connection
 154 .TP
 155 .SM ldap_unbind(3) and ldap_unbind_s(3) are
 156 equivalent to
 157 .BR ldap_unbind_ext (3)
 158 .TP
 159 .SM ldap_memfree(3)
 160 dispose of memory allocated by LDAP routines.
 161 .TP
 162 .SM ldap_compare_ext(3)
 163 asynchronously compare to a directory entry
 164 .TP
 165 .SM ldap_compare_ext_s(3)
 166 synchronously compare to a directory entry
 167 .TP
 168 .SM ldap_delete_ext(3)
 169 asynchronously delete an entry
 170 .TP
 171 .SM ldap_delete_ext_s(3)
 172 synchronously delete an entry
 173 .TP
 174 .SM ld_errno(3)
 175 LDAP error indication
 176 .TP
 177 .SM ldap_errlist(3)
 178 list of LDAP errors and their meanings
 179 .TP
 180 .SM ldap_err2string(3)
 181 convert LDAP error indication to a string
 182 .TP
 183 .SM ldap_first_attribute(3)
 184 return first attribute name in an entry
 185 .TP
 186 .SM ldap_next_attribute(3)
 187 return next attribute name in an entry
 188 .TP
 189 .SM ldap_first_entry(3)
 190 return first entry in a chain of search results
 191 .TP
 192 .SM ldap_next_entry(3)
 193 return next entry in a chain of search results
 194 .TP
 195 .SM ldap_count_entries(3)
 196 return number of entries in a search result
 197 .TP
 198 .SM ldap_get_dn(3)
 199 extract the DN from an entry
 200 .TP
 201 .SM ldap_get_values_len(3)
 202 return an attribute's values with lengths
 203 .TP
 204 .SM ldap_value_free_len(3)
 205 free memory allocated by ldap_get_values_len(3)
 206 .TP
 207 .SM ldap_count_values_len(3)
 208 return number of values
 209 .TP
 210 .SM ldap_modify_ext(3)
 211 asynchronously modify an entry
 212 .TP
 213 .SM ldap_modify_ext_s(3)
 214 synchronously modify an entry
 215 .TP
 216 .SM ldap_mods_free(3)
 217 free array of pointers to mod structures used by ldap_modify_ext(3)
 218 .TP
 219 .SM ldap_rename(3)
 220 asynchronously rename an entry
 221 .TP
 222 .SM ldap_rename_s(3)
 223 synchronously rename an entry
 224 .TP
 225 .SM ldap_msgfree(3)
 226 free results allocated by ldap_result(3)
 227 .TP
 228 .SM ldap_msgtype(3)
 229 return the message type of a message from ldap_result(3)
 230 .TP
 231 .SM ldap_msgid(3)
 232 return the message id of a message from ldap_result(3)
 233 .TP
 234 .SM ldap_search_ext(3)
 235 asynchronously search the directory
 236 .TP
 237 .SM ldap_search_ext_s(3)
 238 synchronously search the directory
 239 .TP
 240 .SM ldap_is_ldap_url(3)
 241 check a URL string to see if it is an LDAP URL
 242 .TP
 243 .SM ldap_url_parse(3)
 244 break up an LDAP URL string into its components
 245 .TP
 246 .SM ldap_sort_entries(3)
 247 sort a list of search results
 248 .TP
 249 .SM ldap_sort_values(3)
 250 sort a list of attribute values
 251 .TP
 252 .SM ldap_sort_strcasecmp(3)
 253 case insensitive string comparison
 254 .SH SEE ALSO
 255 .BR ldap.conf (5),
 256 .BR slapd (8),
 257 .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
 258 .SH ACKNOWLEDGEMENTS
 259 .B OpenLDAP
 260 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 261 .B OpenLDAP
 262 is derived from University of Michigan LDAP 3.3 Release.
 263 .LP
 264 These API manual pages are loosely based upon descriptions provided
 265 in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work
 266 in progress.
 267