3 * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms are permitted only
7 * as authorized by the OpenLDAP Public License. A copy of this
8 * license is available at http://www.OpenLDAP.org/license.html or
9 * in file LICENSE in the top-level directory of the distribution.
12 * Copyright (c) 1990 Regents of the University of Michigan.
13 * All rights reserved.
15 * Redistribution and use in source and binary forms are permitted
16 * provided that this notice is preserved and that due credit is given
17 * to the University of Michigan at Ann Arbor. The name of the University
18 * may not be used to endorse or promote products derived from this
19 * software without specific prior written permission. This software
20 * is provided ``as is'' without express or implied warranty.
31 #define LDAP_VERSION1 1
32 #define LDAP_VERSION2 2
33 #define LDAP_VERSION3 3
35 #define LDAP_VERSION_MIN LDAP_VERSION2
36 #define LDAP_VERSION LDAP_VERSION2
37 #define LDAP_VERSION_MAX LDAP_VERSION3
40 * We'll use 2000+draft revision for our API version number
41 * As such, the number will be above the old RFC but below
42 * whatever number does finally get assigned
44 #define LDAP_API_VERSION 2004
45 #define LDAP_VENDOR_NAME "OpenLDAP"
46 /* We'll eventually release as 200 */
47 #define LDAP_VENDOR_VERSION 19905
49 /* OpenLDAP API Features */
50 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
52 /* include LDAP_API_FEATURE defines */
53 #include <ldap_features.h>
55 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
56 ( defined( LDAP_THREAD_SAFE ) && \
57 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
58 /* -lldap may or may not be thread safe */
59 /* -lldap_r, if available, is always thread safe */
60 # define LDAP_API_FEATURE_THREAD_SAFE 1
62 #if defined( LDAP_THREAD_SAFE ) && \
63 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
64 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
65 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
68 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
69 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
71 #define LDAP_ROOT_DSE ""
72 #define LDAP_NO_ATTRS "1.1"
73 #define LDAP_ALL_USER_ATTRIBUTES "*"
74 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
77 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
78 * 0x0000 - 0x0fff reserved for api options
79 * 0x1000 - 0x3fff reserved for api extended options
80 * 0x4000 - 0x7fff reserved for private and experimental options
82 #define LDAP_OPT_API_INFO 0x0000
83 #define LDAP_OPT_DESC 0x0001 /* deprecated */
84 #define LDAP_OPT_DEREF 0x0002
85 #define LDAP_OPT_SIZELIMIT 0x0003
86 #define LDAP_OPT_TIMELIMIT 0x0004
87 /* 0x05 - 0x07 not defined by current draft */
88 #define LDAP_OPT_REFERRALS 0x0008
89 #define LDAP_OPT_RESTART 0x0009
90 /* 0x0a - 0x10 not defined by current draft */
91 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
92 #define LDAP_OPT_SERVER_CONTROLS 0x0012
93 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
94 /* 0x14 not defined by current draft */
95 #define LDAP_OPT_API_FEATURE_INFO 0x0015
97 /* 0x16 - 0x2f not defined by current draft */
98 #define LDAP_OPT_HOST_NAME 0x0030
99 #define LDAP_OPT_ERROR_NUMBER 0x0031
100 #define LDAP_OPT_ERROR_STRING 0x0032
101 #define LDAP_OPT_MATCHED_DN 0x0033
103 /* 0x34 - 0x0fff not defined by current draft */
105 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
107 /* private and experimental options */
108 /* OpenLDAP specific options */
109 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
110 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
111 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
112 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
113 #define LDAP_OPT_URI 0x5006
115 /* OpenLDAP TLS options */
116 #define LDAP_OPT_X_TLS_CACERTFILE 0x6001
117 #define LDAP_OPT_X_TLS_CACERTDIR 0x6002
118 #define LDAP_OPT_X_TLS_CERT 0x6003
119 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
120 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
121 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
122 #define LDAP_OPT_X_TLS 0x6007
123 #define LDAP_OPT_X_TLS_PROTOCOL 0x6008
124 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6009
126 #define LDAP_OPT_X_TLS_NEVER 0
127 #define LDAP_OPT_X_TLS_HARD 1
128 #define LDAP_OPT_X_TLS_DEMAND 2
129 #define LDAP_OPT_X_TLS_ALLOW 3
130 #define LDAP_OPT_X_TLS_TRY 4
132 /* OpenLDAP SASL options */
133 #define LDAP_OPT_X_SASL_MINSSF 0x6100
134 #define LDAP_OPT_X_SASL_MAXSSF 0x6101
135 #define LDAP_OPT_X_SASL_ACTSSF 0x6102
138 #define LDAP_OPT_ON ((void *) 1)
139 #define LDAP_OPT_OFF ((void *) 0)
142 * ldap_get_option() and ldap_set_option() return values.
143 * As later versions may return other values indicating
144 * failure, current applications should only compare returned
145 * value against LDAP_OPT_SUCCESS.
147 #define LDAP_OPT_SUCCESS 0
148 #define LDAP_OPT_ERROR (-1)
150 #define LDAP_API_INFO_VERSION (1)
151 typedef struct ldapapiinfo {
152 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
153 int ldapai_api_version; /* revision of API supported */
154 int ldapai_protocol_version; /* highest LDAP version supported */
155 char **ldapai_extensions; /* names of API extensions */
156 char *ldapai_vendor_name; /* name of supplier */
157 int ldapai_vendor_version; /* supplier-specific version * 100 */
160 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
161 typedef struct ldap_apifeature_info {
162 int ldapaif_info_version; /* version of this struct (1) */
163 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
164 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
165 } LDAPAPIFeatureInfo;
167 typedef struct ldapcontrol {
169 struct berval ldctl_value;
170 char ldctl_iscritical;
174 /* chase referrals controls */
175 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
176 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
177 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
179 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
181 /* Experimental Controls */
183 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
184 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
185 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
186 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
188 /* LDAP Unsolicited Notifications */
189 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
190 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
192 /* LDAP Extended Operations */
193 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
195 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
196 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
197 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
198 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
199 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
202 * specific LDAP instantiations of BER types we know about
205 /* Overview of LBER tag construction
212 * 1 0 = CONTEXT-SPECIFIC
219 * | 5 ... 1 | TAG-NUMBER
223 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
224 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
225 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octect string */
226 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octect string */
227 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
228 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
230 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
232 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
233 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
234 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
235 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
237 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
240 /* possible operations a client can invoke */
241 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
242 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
243 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
244 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
245 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
246 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
247 #define LDAP_REQ_MODRDN ((ber_tag_t) 0x6cU) /* application + constructed */
248 #define LDAP_REQ_MODDN LDAP_REQ_MODRDN
249 #define LDAP_REQ_RENAME LDAP_REQ_MODRDN
250 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
251 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
252 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
254 /* possible result types a server can return */
255 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
256 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
257 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
258 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
259 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
260 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
261 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
262 #define LDAP_RES_MODRDN ((ber_tag_t) 0x6dU) /* application + constructed */
263 #define LDAP_RES_MODDN LDAP_RES_MODRDN /* application + constructed */
264 #define LDAP_RES_RENAME LDAP_RES_MODRDN /* application + constructed */
265 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
266 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
267 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
269 #define LDAP_RES_ANY ((ber_tag_t)(-1))
270 #define LDAP_RES_UNSOLICITED ((ber_tag_t)(0))
274 #define LDAP_SASL_SIMPLE NULL
276 /* authentication methods available */
277 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
278 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
279 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + primitive */
280 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
281 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
282 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
286 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
287 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
288 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
289 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
290 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
291 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
292 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
293 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
294 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
295 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
297 /* extended filter component types */
298 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
299 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
300 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
301 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
303 /* substring filter component types */
304 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
305 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
306 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
309 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
310 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
311 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
313 /* substring filter component types */
314 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
315 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
316 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
319 * possible error codes we can return
322 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
324 #define LDAP_SUCCESS 0x00
325 #define LDAP_OPERATIONS_ERROR 0x01
326 #define LDAP_PROTOCOL_ERROR 0x02
327 #define LDAP_TIMELIMIT_EXCEEDED 0x03
328 #define LDAP_SIZELIMIT_EXCEEDED 0x04
329 #define LDAP_COMPARE_FALSE 0x05
330 #define LDAP_COMPARE_TRUE 0x06
331 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
332 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
333 #define LDAP_STRONG_AUTH_REQUIRED 0x08
334 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
336 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
337 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
338 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
339 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
340 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
342 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
344 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
345 #define LDAP_UNDEFINED_TYPE 0x11
346 #define LDAP_INAPPROPRIATE_MATCHING 0x12
347 #define LDAP_CONSTRAINT_VIOLATION 0x13
348 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
349 #define LDAP_INVALID_SYNTAX 0x15
351 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
353 #define LDAP_NO_SUCH_OBJECT 0x20
354 #define LDAP_ALIAS_PROBLEM 0x21
355 #define LDAP_INVALID_DN_SYNTAX 0x22
356 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
357 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
359 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
361 #define LDAP_INAPPROPRIATE_AUTH 0x30
362 #define LDAP_INVALID_CREDENTIALS 0x31
363 #define LDAP_INSUFFICIENT_ACCESS 0x32
365 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
367 #define LDAP_BUSY 0x33
368 #define LDAP_UNAVAILABLE 0x34
369 #define LDAP_UNWILLING_TO_PERFORM 0x35
370 #define LDAP_LOOP_DETECT 0x36
372 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
374 #define LDAP_NAMING_VIOLATION 0x40
375 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
376 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
377 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
378 #define LDAP_ALREADY_EXISTS 0x44
379 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
380 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
381 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
383 #define LDAP_OTHER 0x50
385 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
387 #define LDAP_SERVER_DOWN 0x51
388 #define LDAP_LOCAL_ERROR 0x52
389 #define LDAP_ENCODING_ERROR 0x53
390 #define LDAP_DECODING_ERROR 0x54
391 #define LDAP_TIMEOUT 0x55
392 #define LDAP_AUTH_UNKNOWN 0x56
393 #define LDAP_FILTER_ERROR 0x57
394 #define LDAP_USER_CANCELLED 0x58
395 #define LDAP_PARAM_ERROR 0x59
396 #define LDAP_NO_MEMORY 0x5a
398 /* not technically reserved for APIs */
399 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
400 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
401 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
402 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
403 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
404 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
405 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
408 * This structure represents both ldap messages and ldap responses.
409 * These are really the same, except in the case of search responses,
410 * where a response has multiple messages.
413 typedef struct ldapmsg LDAPMessage;
415 /* for modifications */
416 typedef struct ldapmod {
419 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
420 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
421 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
422 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
423 /* IMPORTANT: do not use code 0x1000 (or above),
424 * it is used internally by the backends!
425 * (see ldap/servers/slapd/slap.h)
431 struct berval **modv_bvals;
433 #define mod_values mod_vals.modv_strvals
434 #define mod_bvalues mod_vals.modv_bvals
438 * structures for ldap getfilter routines
441 typedef struct ldap_filt_info {
446 struct ldap_filt_info *lfi_next;
449 typedef struct ldap_filt_list {
453 LDAPFiltInfo *lfl_ilist;
454 struct ldap_filt_list *lfl_next;
458 #define LDAP_FILT_MAXSIZ 1024
460 typedef struct ldap_filt_desc {
461 LDAPFiltList *lfd_filtlist;
462 LDAPFiltInfo *lfd_curfip;
463 LDAPFiltInfo lfd_retfi;
464 char lfd_filter[ LDAP_FILT_MAXSIZ ];
466 char *lfd_curvalcopy;
467 char **lfd_curvalwords;
468 char *lfd_filtprefix;
469 char *lfd_filtsuffix;
474 * structure representing an ldap session which can
475 * encompass connections to multiple servers (in the
476 * face of referrals).
478 typedef struct ldap LDAP;
480 #define LDAP_DEREF_NEVER 0x00
481 #define LDAP_DEREF_SEARCHING 0x01
482 #define LDAP_DEREF_FINDING 0x02
483 #define LDAP_DEREF_ALWAYS 0x03
485 #define LDAP_NO_LIMIT 0
487 /* how many messages to retrieve results for */
488 #define LDAP_MSG_ONE 0x00
489 #define LDAP_MSG_ALL 0x01
490 #define LDAP_MSG_RECEIVED 0x02
493 * structure for ldap friendly mapping routines
496 typedef struct ldap_friendly {
502 * types for ldap URL handling
504 typedef struct ldap_url_desc {
505 struct ldap_url_desc *lud_next;
516 #define LDAP_URL_SUCCESS 0x00 /* Success */
517 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
518 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
520 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
521 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
522 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
523 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
524 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
525 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
526 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
527 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
530 * The API draft spec says we should declare (or cause to be declared)
531 * 'struct timeval'. We don't. See IETF LDAPext discussions.
539 ldap_get_option LDAP_P((
545 ldap_set_option LDAP_P((
548 LDAP_CONST void *invalue));
550 /* V3 REBIND Function Callback Prototype */
551 typedef int (LDAP_REBIND_PROC) LDAP_P((
552 LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
555 ldap_set_rebind_proc LDAP_P((
557 LDAP_REBIND_PROC *ldap_proc));
563 ldap_control_free LDAP_P((
564 LDAPControl *ctrl ));
567 ldap_controls_free LDAP_P((
568 LDAPControl **ctrls ));
574 ldap_domain2dn LDAP_P((
575 LDAP_CONST char* domain,
579 ldap_dn2domain LDAP_P((
584 ldap_domain2hostlist LDAP_P((
585 LDAP_CONST char *domain,
592 ldap_extended_operation LDAP_P((
594 LDAP_CONST char *reqoid,
595 struct berval *reqdata,
596 LDAPControl **serverctrls,
597 LDAPControl **clientctrls,
601 ldap_extended_operation_s LDAP_P((
603 LDAP_CONST char *reqoid,
604 struct berval *reqdata,
605 LDAPControl **serverctrls,
606 LDAPControl **clientctrls,
608 struct berval **retdatap ));
611 ldap_parse_extended_result LDAP_P((
615 struct berval **retdatap,
619 ldap_parse_extended_partial LDAP_P((
623 struct berval **retdatap,
624 LDAPControl ***serverctrls,
631 ldap_abandon_ext LDAP_P((
634 LDAPControl **serverctrls,
635 LDAPControl **clientctrls ));
638 ldap_abandon LDAP_P(( /* deprecated */
647 ldap_add_ext LDAP_P((
651 LDAPControl **serverctrls,
652 LDAPControl **clientctrls,
656 ldap_add_ext_s LDAP_P((
660 LDAPControl **serverctrls,
661 LDAPControl **clientctrls ));
664 ldap_add LDAP_P(( /* deprecated */
670 ldap_add_s LDAP_P(( /* deprecated */
680 ldap_sasl_bind LDAP_P((
683 LDAP_CONST char *mechanism,
685 LDAPControl **serverctrls,
686 LDAPControl **clientctrls,
690 ldap_negotiated_sasl_bind_s LDAP_P((
692 LDAP_CONST char *dn, /* usually NULL */
693 LDAP_CONST char *authenticationId,
694 LDAP_CONST char *authorizationId, /* usually NULL */
695 LDAP_CONST char *saslMechanism,
696 struct berval *passPhrase,
697 LDAPControl **serverControls,
698 LDAPControl **clientControls ));
701 ldap_sasl_bind_s LDAP_P((
704 LDAP_CONST char *mechanism,
706 LDAPControl **serverctrls,
707 LDAPControl **clientctrls,
708 struct berval **servercredp ));
711 ldap_parse_sasl_bind_result LDAP_P((
714 struct berval **servercredp,
722 ldap_bind LDAP_P(( /* deprecated */
724 LDAP_CONST char *who,
725 LDAP_CONST char *passwd,
729 ldap_bind_s LDAP_P(( /* deprecated */
731 LDAP_CONST char *who,
732 LDAP_CONST char *cred,
739 ldap_simple_bind LDAP_P((
741 LDAP_CONST char *who,
742 LDAP_CONST char *passwd ));
745 ldap_simple_bind_s LDAP_P((
747 LDAP_CONST char *who,
748 LDAP_CONST char *passwd ));
756 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
758 LDAP_CONST char *who ));
761 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
763 LDAP_CONST char *who ));
766 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
768 LDAP_CONST char *who ));
771 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
773 LDAP_CONST char *who ));
776 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
778 LDAP_CONST char *who ));
785 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
788 ldap_disable_cache LDAP_P(( LDAP *ld ));
791 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
794 ldap_destroy_cache LDAP_P(( LDAP *ld ));
797 ldap_flush_cache LDAP_P(( LDAP *ld ));
800 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
803 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
810 ldap_compare_ext LDAP_P((
813 LDAP_CONST char *attr,
814 struct berval *bvalue,
815 LDAPControl **serverctrls,
816 LDAPControl **clientctrls,
820 ldap_compare_ext_s LDAP_P((
823 LDAP_CONST char *attr,
824 struct berval *bvalue,
825 LDAPControl **serverctrls,
826 LDAPControl **clientctrls ));
829 ldap_compare LDAP_P(( /* deprecated */
832 LDAP_CONST char *attr,
833 LDAP_CONST char *value ));
836 ldap_compare_s LDAP_P(( /* deprecated */
839 LDAP_CONST char *attr,
840 LDAP_CONST char *value ));
847 ldap_delete_ext LDAP_P((
850 LDAPControl **serverctrls,
851 LDAPControl **clientctrls,
855 ldap_delete_ext_s LDAP_P((
858 LDAPControl **serverctrls,
859 LDAPControl **clientctrls ));
862 ldap_delete LDAP_P(( /* deprecated */
864 LDAP_CONST char *dn ));
867 ldap_delete_s LDAP_P(( /* deprecated */
869 LDAP_CONST char *dn ));
876 ldap_parse_result LDAP_P((
883 LDAPControl ***serverctrls,
887 ldap_err2string LDAP_P((
891 ldap_result2error LDAP_P(( /* deprecated */
897 ldap_perror LDAP_P(( /* deprecated */
899 LDAP_CONST char *s ));
906 ldap_modify_ext LDAP_P((
910 LDAPControl **serverctrls,
911 LDAPControl **clientctrls,
915 ldap_modify_ext_s LDAP_P((
919 LDAPControl **serverctrls,
920 LDAPControl **clientctrls ));
923 ldap_modify LDAP_P(( /* deprecated */
929 ldap_modify_s LDAP_P(( /* deprecated */
942 LDAP_CONST char *newrdn,
943 LDAP_CONST char *newSuperior,
945 LDAPControl **sctrls,
946 LDAPControl **cctrls,
950 ldap_rename_s LDAP_P((
953 LDAP_CONST char *newrdn,
954 LDAP_CONST char *newSuperior,
956 LDAPControl **sctrls,
957 LDAPControl **cctrls ));
960 ldap_rename2 LDAP_P(( /* deprecated */
963 LDAP_CONST char *newrdn,
964 LDAP_CONST char *newSuperior,
968 ldap_rename2_s LDAP_P(( /* deprecated */
971 LDAP_CONST char *newrdn,
972 LDAP_CONST char *newSuperior,
976 ldap_modrdn LDAP_P(( /* deprecated */
979 LDAP_CONST char *newrdn ));
982 ldap_modrdn_s LDAP_P(( /* deprecated */
985 LDAP_CONST char *newrdn ));
988 ldap_modrdn2 LDAP_P(( /* deprecated */
991 LDAP_CONST char *newrdn,
995 ldap_modrdn2_s LDAP_P(( /* deprecated */
998 LDAP_CONST char *newrdn,
1007 LDAP_CONST char *host,
1011 ldap_open LDAP_P(( /* deprecated */
1012 LDAP_CONST char *host,
1016 ldap_create LDAP_P((
1020 ldap_initialize LDAP_P((
1022 LDAP_CONST char *url ));
1025 ldap_start_tls_s LDAP_P((
1027 LDAPControl **serverctrls,
1028 LDAPControl **clientctrls ));
1033 LDAP_F( LDAPMessage *)
1034 ldap_first_message LDAP_P((
1036 LDAPMessage *chain ));
1038 LDAP_F( LDAPMessage *)
1039 ldap_next_message LDAP_P((
1041 LDAPMessage *msg ));
1044 ldap_count_messages LDAP_P((
1046 LDAPMessage *chain ));
1052 LDAP_F( LDAPMessage *)
1053 ldap_first_reference LDAP_P((
1055 LDAPMessage *chain ));
1057 LDAP_F( LDAPMessage *)
1058 ldap_next_reference LDAP_P((
1060 LDAPMessage *ref ));
1063 ldap_count_references LDAP_P((
1065 LDAPMessage *chain ));
1068 ldap_parse_reference LDAP_P((
1072 LDAPControl ***serverctrls,
1079 LDAP_F( LDAPMessage *)
1080 ldap_first_entry LDAP_P((
1082 LDAPMessage *chain ));
1084 LDAP_F( LDAPMessage *)
1085 ldap_next_entry LDAP_P((
1087 LDAPMessage *entry ));
1090 ldap_count_entries LDAP_P((
1092 LDAPMessage *chain ));
1095 ldap_get_entry_controls LDAP_P((
1098 LDAPControl ***serverctrls));
1104 LDAP_F( LDAPMessage *)
1105 ldap_delete_result_entry LDAP_P((
1110 ldap_add_result_entry LDAP_P((
1119 ldap_get_dn LDAP_P((
1121 LDAPMessage *entry ));
1124 ldap_dn2ufn LDAP_P((
1125 LDAP_CONST char *dn ));
1128 ldap_explode_dn LDAP_P((
1129 LDAP_CONST char *dn,
1133 ldap_explode_rdn LDAP_P((
1134 LDAP_CONST char *rdn,
1138 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1141 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1147 ldap_first_attribute LDAP_P((
1150 BerElement **ber ));
1153 ldap_next_attribute LDAP_P((
1163 ldap_get_values LDAP_P((
1166 LDAP_CONST char *target ));
1168 LDAP_F( struct berval **)
1169 ldap_get_values_len LDAP_P((
1172 LDAP_CONST char *target ));
1175 ldap_count_values LDAP_P((
1179 ldap_count_values_len LDAP_P((
1180 struct berval **vals ));
1183 ldap_value_free LDAP_P((
1187 ldap_value_free_len LDAP_P((
1188 struct berval **vals ));
1194 ldap_result LDAP_P((
1198 struct timeval *timeout,
1199 LDAPMessage **result ));
1202 ldap_msgtype LDAP_P((
1210 ldap_msgfree LDAP_P((
1214 ldap_msgdelete LDAP_P((
1223 ldap_search_ext LDAP_P((
1225 LDAP_CONST char *base,
1227 LDAP_CONST char *filter,
1230 LDAPControl **serverctrls,
1231 LDAPControl **clientctrls,
1232 struct timeval *timeout,
1237 ldap_search_ext_s LDAP_P((
1239 LDAP_CONST char *base,
1241 LDAP_CONST char *filter,
1244 LDAPControl **serverctrls,
1245 LDAPControl **clientctrls,
1246 struct timeval *timeout,
1248 LDAPMessage **res ));
1251 ldap_search LDAP_P(( /* deprecated */
1253 LDAP_CONST char *base,
1255 LDAP_CONST char *filter,
1260 ldap_search_s LDAP_P(( /* deprecated */
1262 LDAP_CONST char *base,
1264 LDAP_CONST char *filter,
1267 LDAPMessage **res ));
1270 ldap_search_st LDAP_P(( /* deprecated */
1272 LDAP_CONST char *base,
1274 LDAP_CONST char *filter,
1277 struct timeval *timeout,
1278 LDAPMessage **res ));
1286 ldap_ufn_search_c LDAP_P(( /* deprecated */
1288 LDAP_CONST char *ufn,
1292 int (*cancelproc)( void *cl ),
1293 void *cancelparm ));
1296 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1298 LDAP_CONST char *ufn,
1302 int (*cancelproc)( void *cl ),
1309 ldap_ufn_search_s LDAP_P(( /* deprecated */
1311 LDAP_CONST char *ufn,
1314 LDAPMessage **res ));
1316 LDAP_F( LDAPFiltDesc *)
1317 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1319 LDAP_CONST char *fname ));
1322 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1324 LDAP_CONST char *prefix ));
1327 ldap_ufn_timeout LDAP_P(( /* deprecated */
1335 ldap_unbind LDAP_P(( /* deprecated */
1339 ldap_unbind_s LDAP_P(( /* deprecated */
1343 ldap_unbind_ext LDAP_P((
1345 LDAPControl **serverctrls,
1346 LDAPControl **clientctrls));
1349 ldap_unbind_ext_s LDAP_P((
1351 LDAPControl **serverctrls,
1352 LDAPControl **clientctrls));
1358 LDAP_F( LDAPFiltDesc *)
1359 ldap_init_getfilter LDAP_P(( /* deprecated */
1360 LDAP_CONST char *fname ));
1362 LDAP_F( LDAPFiltDesc *)
1363 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1364 /* LDAP_CONST */ char *buf,
1365 ber_len_t buflen ));
1367 LDAP_F( LDAPFiltInfo *)
1368 ldap_getfirstfilter LDAP_P(( /* deprecated */
1370 /* LDAP_CONST */ char *tagpat,
1371 /* LDAP_CONST */ char *value ));
1373 LDAP_F( LDAPFiltInfo *)
1374 ldap_getnextfilter LDAP_P(( /* deprecated */
1375 LDAPFiltDesc *lfdp ));
1378 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1380 LDAP_CONST char *prefix,
1381 LDAP_CONST char *suffix ));
1384 ldap_build_filter LDAP_P(( /* deprecated */
1387 LDAP_CONST char *pattern,
1388 LDAP_CONST char *prefix,
1389 LDAP_CONST char *suffix,
1390 LDAP_CONST char *attr,
1391 LDAP_CONST char *value,
1400 ldap_memalloc LDAP_P((
1404 ldap_memrealloc LDAP_P((
1409 ldap_memcalloc LDAP_P((
1414 ldap_memfree LDAP_P((
1418 ldap_memvfree LDAP_P((
1422 ldap_strdup LDAP_P((
1423 LDAP_CONST char * ));
1426 ldap_getfilter_free LDAP_P((
1427 LDAPFiltDesc *lfdp ));
1430 ldap_mods_free LDAP_P((
1440 ldap_friendly_name LDAP_P(( /* deprecated */
1441 LDAP_CONST char *filename,
1442 /* LDAP_CONST */ char *uname,
1443 LDAPFriendlyMap **map ));
1446 ldap_free_friendlymap LDAP_P(( /* deprecated */
1447 LDAPFriendlyMap **map ));
1455 cldap_open LDAP_P(( /* deprecated */
1456 LDAP_CONST char *host,
1460 cldap_close LDAP_P(( /* deprecated */
1464 cldap_search_s LDAP_P(( /* deprecated */
1466 LDAP_CONST char *base,
1468 LDAP_CONST char *filter,
1475 cldap_setretryinfo LDAP_P(( /* deprecated */
1484 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1485 LDAP_CONST char *left,
1486 LDAP_CONST char *right ));
1488 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1489 LDAP_CONST void *left,
1490 LDAP_CONST void *right ));
1493 ldap_sort_entries LDAP_P(( LDAP *ld,
1494 LDAPMessage **chain,
1495 LDAP_CONST char *attr,
1496 LDAP_SORT_AD_CMP_PROC *cmp ));
1498 LDAP_F( int ) /* deprecated */
1499 ldap_sort_values LDAP_P((
1502 LDAP_SORT_AV_CMP_PROC *cmp ));
1504 LDAP_F( int ) /* deprecated */
1505 ldap_sort_strcasecmp LDAP_P((
1507 LDAP_CONST void *b ));
1513 * need _ext varients
1516 ldap_is_ldap_url LDAP_P((
1517 LDAP_CONST char *url ));
1520 ldap_is_ldaps_url LDAP_P((
1521 LDAP_CONST char *url ));
1524 ldap_is_ldapi_url LDAP_P((
1525 LDAP_CONST char *url ));
1528 ldap_url_parse LDAP_P((
1529 LDAP_CONST char *url,
1530 LDAPURLDesc **ludpp ));
1533 ldap_free_urldesc LDAP_P((
1534 LDAPURLDesc *ludp ));
1537 ldap_url_search LDAP_P((
1539 LDAP_CONST char *url,
1543 ldap_url_search_s LDAP_P((
1545 LDAP_CONST char *url,
1547 LDAPMessage **res ));
1550 ldap_url_search_st LDAP_P((
1552 LDAP_CONST char *url,
1554 struct timeval *timeout,
1555 LDAPMessage **res ));
1561 * structure for a sort-key
1563 typedef struct ldapsortkey {
1564 char * attributeType;
1565 char * orderingRule;
1570 ldap_create_sort_keylist LDAP_P((
1571 LDAPSortKey ***sortKeyList,
1575 ldap_free_sort_keylist LDAP_P((
1576 LDAPSortKey **sortkeylist ));
1579 ldap_create_sort_control LDAP_P((
1581 LDAPSortKey **keyList,
1583 LDAPControl **ctrlp ));
1586 ldap_parse_sort_control LDAP_P((
1588 LDAPControl **ctrlp,
1589 unsigned long *result,
1590 char **attribute ));
1598 * structure for virtul list.
1600 typedef struct ldapvlvinfo {
1602 unsigned long ldvlv_before_count;
1603 unsigned long ldvlv_after_count;
1604 unsigned long ldvlv_offset;
1605 unsigned long ldvlv_count;
1606 struct berval *ldvlv_attrvalue;
1607 struct berval *ldvlv_context;
1608 void *ldvlv_extradata;
1612 ldap_create_vlv_control LDAP_P((
1614 LDAPVLVInfo *ldvlistp,
1615 LDAPControl **ctrlp ));
1618 ldap_parse_vlv_control LDAP_P((
1620 LDAPControl **ctrls,
1621 unsigned long *target_posp,
1622 unsigned long *list_countp,
1623 struct berval **contextp,
1628 #endif /* _LDAP_H */