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

   1 .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2005 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 A Start TLS operation is performed by calling
  44 .BR ldap_start_tls_s (3).
  45 A LDAP bind operation is performed by calling
  46 .BR ldap_sasl_bind (3)
  47 or one of its friends.  Subsequently, other operations are performed
  48 by calling one of the synchronous or asynchronous routines (e.g.,
  49 .BR ldap_search_ext_s (3)
  50 or
  51 .BR ldap_search_ext (3)
  52 followed by
  53 .BR ldap_result (3)).
  54 Results returned from these routines are interpreted by calling the
  55 LDAP parsing routines such as
  56 .BR ldap_parse_result (3).
  57 The LDAP association and underlying connection is terminated by calling
  58 .BR ldap_unbind_ext (3).
  59 Errors can be interpreted by calling
  60 .BR ldap_err2string (3).
  61 .SH LDAP versions
  62 This library supports version 3 of the Lightweight Directory Access
  63 Protocol (LDAPv3) as defined in RFC 3377.  It also supports a variant
  64 of version 2 of LDAP as defined by U-Mich LDAP and, to some degree,
  65 RFC 1777.  Version 2 (all variants) should be viewed as obsolete.
  66 Version 3 should be used instead.
  67 .LP
  68 For backwards compatibility reasons, the library defaults to version 2.
  69 Hence, all new applications (and all actively maintained applications)
  70 should use
  71 .BR ldap_set_option (3)
  72 to select version 3.  The library manual pages assume version 3
  73 has been selected.
  74 .SH INPUT and OUTPUT PARAMETERS
  75 All character string input/output is expected to be/is UTF\-8
  76 encoded Unicode (version 3.2).
  77 .LP
  78 Distinguished names (DN) (and relative distinguished names (RDN) to
  79 be passed to the LDAP routines should conform to RFC 2253 UTF\-8
  80 string representation.
  81 .LP
  82 Search filters to be passed to the search routines are to be
  83 constructed by hand and should conform to RFC 2254 UTF\-8
  84 string representation.
  85 .LP
  86 LDAP URL are to be passed to routines are expected to conform
  87 to RFC 2255 syntax.  The
  88 .BR ldap_url (3)
  89 routines can be used to work with LDAP URLs.
  90 .SH DISPLAYING RESULTS
  91 Results obtained from the search routines can be output by hand,
  92 by calling
  93 .BR ldap_first_entry (3)
  94 and
  95 .BR ldap_next_entry (3)
  96 to step through
  97 the entries returned,
  98 .BR ldap_first_attribute (3)
  99 and
 100 .BR ldap_next_attribute (3)
 101 to step through an entry's attributes, and
 102 .BR ldap_get_values (3)
 103 to retrieve a given attribute's values.  Attribute values
 104 may or may not be displayable.
 105 .SH UTILITY ROUTINES
 106 Also provided are various utility routines.  The
 107 .BR ldap_sort (3)
 108 routines are used to sort the entries and values returned via
 109 the ldap search routines.
 110 .SH BER LIBRARY
 111 Also included in the distribution is a set of lightweight Basic
 112 Encoding Rules routines.  These routines are used by the LDAP library
 113 routines to encode and decode LDAP protocol elements using the
 114 (slightly simplified) Basic Encoding Rules defined by LDAP.  They are
 115 not normally used directly by an LDAP application program except
 116 in the handling of controls and extended operations.  The
 117 routines provide a printf and scanf\-like interface, as well as
 118 lower\-level access.  These routines are discussed in
 119 .BR lber\-decode (3),
 120 .BR lber\-encode (3),
 121 .BR lber\-memory (3),
 122 and
 123 .BR lber\-types (3).
 124 .SH INDEX
 125 .TP 20
 126 .SM ldap_initialize(3)
 127 initialize the LDAP library without opening a connection to a server
 128 .TP
 129 .SM ldap_result(3)
 130 wait for the result from an asynchronous operation
 131 .TP
 132 .SM ldap_abandon_ext(3)
 133 abandon (abort) an asynchronous operation
 134 .TP
 135 .SM ldap_add_ext(3)
 136 asynchronously add an entry
 137 .TP
 138 .SM ldap_add_ext_s(3)
 139 synchronously add an entry
 140 .TP
 141 .SM ldap_sasl_bind(3)
 142 asynchronously bind to the directory
 143 .TP
 144 .SM ldap_sasl_bind_s(3)
 145 synchronously bind to the directory
 146 .TP
 147 .SM ldap_unbind_ext(3)
 148 synchronously unbind from the LDAP server and close the connection
 149 .TP
 150 .SM ldap_unbind(3) and ldap_unbind_s(3) are
 151 equivalent to
 152 .BR ldap_unbind_ext (3)
 153 .TP
 154 .SM ldap_memfree(3)
 155 dispose of memory allocated by LDAP routines.
 156 .TP
 157 .SM ldap_compare_ext(3)
 158 asynchronously compare to a directory entry
 159 .TP
 160 .SM ldap_compare_ext_s(3)
 161 synchronously compare to a directory entry
 162 .TP
 163 .SM ldap_delete_ext(3)
 164 asynchronously delete an entry
 165 .TP
 166 .SM ldap_delete_ext_s(3)
 167 synchronously delete an entry
 168 .TP
 169 .SM ld_errno(3)
 170 LDAP error indication
 171 .TP
 172 .SM ldap_errlist(3)
 173 list of LDAP errors and their meanings
 174 .TP
 175 .SM ldap_err2string(3)
 176 convert LDAP error indication to a string
 177 .TP
 178 .SM ldap_first_attribute(3)
 179 return first attribute name in an entry
 180 .TP
 181 .SM ldap_next_attribute(3)
 182 return next attribute name in an entry
 183 .TP
 184 .SM ldap_first_entry(3)
 185 return first entry in a chain of search results
 186 .TP
 187 .SM ldap_next_entry(3)
 188 return next entry in a chain of search results
 189 .TP
 190 .SM ldap_count_entries(3)
 191 return number of entries in a search result
 192 .TP
 193 .SM ldap_get_dn(3)
 194 extract the DN from an entry
 195 .TP
 196 .SM ldap_get_values_len(3)
 197 return an attribute's values with lengths
 198 .TP
 199 .SM ldap_value_free_len(3)
 200 free memory allocated by ldap_get_values_len(3)
 201 .TP
 202 .SM ldap_count_values_len(3)
 203 return number of values
 204 .TP
 205 .SM ldap_modify_ext(3)
 206 asynchronously modify an entry
 207 .TP
 208 .SM ldap_modify_ext_s(3)
 209 synchronously modify an entry
 210 .TP
 211 .SM ldap_mods_free(3)
 212 free array of pointers to mod structures used by ldap_modify_ext(3)
 213 .TP
 214 .SM ldap_rename(3)
 215 asynchronously rename an entry
 216 .TP
 217 .SM ldap_rename_s(3)
 218 synchronously rename an entry
 219 .TP
 220 .SM ldap_msgfree(3)
 221 free results allocated by ldap_result(3)
 222 .TP
 223 .SM ldap_msgtype(3)
 224 return the message type of a message from ldap_result(3)
 225 .TP
 226 .SM ldap_msgid(3)
 227 return the message id of a message from ldap_result(3)
 228 .TP
 229 .SM ldap_search_ext(3)
 230 asynchronously search the directory
 231 .TP
 232 .SM ldap_search_ext_s(3)
 233 synchronously search the directory
 234 .TP
 235 .SM ldap_is_ldap_url(3)
 236 check a URL string to see if it is an LDAP URL
 237 .TP
 238 .SM ldap_url_parse(3)
 239 break up an LDAP URL string into its components
 240 .TP
 241 .SM ldap_sort_entries(3)
 242 sort a list of search results
 243 .TP
 244 .SM ldap_sort_values(3)
 245 sort a list of attribute values
 246 .TP
 247 .SM ldap_sort_strcasecmp(3)
 248 case insensitive string comparison
 249 .SH SEE ALSO
 250 .BR ldap.conf (5),
 251 .BR slapd (8),
 252 .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
 253 .SH ACKNOWLEDGEMENTS
 254 .B OpenLDAP
 255 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 256 .B OpenLDAP
 257 is derived from University of Michigan LDAP 3.3 Release.
 258 .LP
 259 These API manual pages are loosely based upon descriptions provided
 260 in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work
 261 in progress.
 262