3 * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted only as authorized by the OpenLDAP
8 * Public License. A copy of this license is available at
9 * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10 * top-level directory of the distribution.
13 * Copyright (c) 1990 Regents of the University of Michigan.
14 * All rights reserved.
16 * Redistribution and use in source and binary forms are permitted
17 * provided that this notice is preserved and that due credit is given
18 * to the University of Michigan at Ann Arbor. The name of the University
19 * may not be used to endorse or promote products derived from this
20 * software without specific prior written permission. This software
21 * is provided ``as is'' without express or implied warranty.
30 /* include version and API feature defines */
31 #include <ldap_features.h>
35 #define LDAP_VERSION1 1
36 #define LDAP_VERSION2 2
37 #define LDAP_VERSION3 3
39 #define LDAP_VERSION_MIN LDAP_VERSION2
40 #define LDAP_VERSION LDAP_VERSION2
41 #define LDAP_VERSION_MAX LDAP_VERSION3
44 * We'll use 2000+draft revision for our API version number
45 * As such, the number will be above the old RFC but below
46 * whatever number does finally get assigned
48 #define LDAP_API_VERSION 2004
49 #define LDAP_VENDOR_NAME "OpenLDAP"
51 /* OpenLDAP API Features */
52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
55 ( defined( LDAP_THREAD_SAFE ) && \
56 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
57 /* -lldap may or may not be thread safe */
58 /* -lldap_r, if available, is always thread safe */
59 # define LDAP_API_FEATURE_THREAD_SAFE 1
61 #if defined( LDAP_THREAD_SAFE ) && \
62 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
63 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
64 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
67 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
68 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
70 #define LDAP_ROOT_DSE ""
71 #define LDAP_NO_ATTRS "1.1"
72 #define LDAP_ALL_USER_ATTRIBUTES "*"
73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
76 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
77 * 0x0000 - 0x0fff reserved for api options
78 * 0x1000 - 0x3fff reserved for api extended options
79 * 0x4000 - 0x7fff reserved for private and experimental options
81 #define LDAP_OPT_API_INFO 0x0000
82 #define LDAP_OPT_DESC 0x0001 /* deprecated */
83 #define LDAP_OPT_DEREF 0x0002
84 #define LDAP_OPT_SIZELIMIT 0x0003
85 #define LDAP_OPT_TIMELIMIT 0x0004
86 /* 0x05 - 0x07 not defined by current draft */
87 #define LDAP_OPT_REFERRALS 0x0008
88 #define LDAP_OPT_RESTART 0x0009
89 /* 0x0a - 0x10 not defined by current draft */
90 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
91 #define LDAP_OPT_SERVER_CONTROLS 0x0012
92 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
93 /* 0x14 not defined by current draft */
94 #define LDAP_OPT_API_FEATURE_INFO 0x0015
96 /* 0x16 - 0x2f not defined by current draft */
97 #define LDAP_OPT_HOST_NAME 0x0030
98 #define LDAP_OPT_ERROR_NUMBER 0x0031
99 #define LDAP_OPT_ERROR_STRING 0x0032
100 #define LDAP_OPT_MATCHED_DN 0x0033
102 /* 0x34 - 0x0fff not defined by current draft */
104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
106 /* private and experimental options */
107 /* OpenLDAP specific options */
108 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
109 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
110 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
111 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
112 #define LDAP_OPT_URI 0x5006
114 /* OpenLDAP TLS options */
115 #define LDAP_OPT_X_TLS 0x6000
116 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
117 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
118 #define LDAP_OPT_X_TLS_CACERTDIR 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_PROTOCOL 0x6007 */
123 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
124 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
125 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
127 #define LDAP_OPT_X_TLS_NEVER 0
128 #define LDAP_OPT_X_TLS_HARD 1
129 #define LDAP_OPT_X_TLS_DEMAND 2
130 #define LDAP_OPT_X_TLS_ALLOW 3
131 #define LDAP_OPT_X_TLS_TRY 4
133 /* OpenLDAP SASL options */
134 #define LDAP_OPT_X_SASL_MECH 0x6100
135 #define LDAP_OPT_X_SASL_REALM 0x6101
136 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
137 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
138 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
139 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
140 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
141 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
142 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
143 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
147 #define LDAP_OPT_ON ((void *) 1)
148 #define LDAP_OPT_OFF ((void *) 0)
151 * ldap_get_option() and ldap_set_option() return values.
152 * As later versions may return other values indicating
153 * failure, current applications should only compare returned
154 * value against LDAP_OPT_SUCCESS.
156 #define LDAP_OPT_SUCCESS 0
157 #define LDAP_OPT_ERROR (-1)
159 #define LDAP_API_INFO_VERSION (1)
160 typedef struct ldapapiinfo {
161 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
162 int ldapai_api_version; /* revision of API supported */
163 int ldapai_protocol_version; /* highest LDAP version supported */
164 char **ldapai_extensions; /* names of API extensions */
165 char *ldapai_vendor_name; /* name of supplier */
166 int ldapai_vendor_version; /* supplier-specific version * 100 */
169 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
170 typedef struct ldap_apifeature_info {
171 int ldapaif_info_version; /* version of this struct (1) */
172 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
173 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
174 } LDAPAPIFeatureInfo;
176 typedef struct ldapcontrol {
178 struct berval ldctl_value;
179 char ldctl_iscritical;
184 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
186 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
187 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
188 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
189 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
191 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
193 /* LDAP Unsolicited Notifications */
194 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
195 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
197 /* LDAP Extended Operations */
198 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
200 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
201 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
202 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
203 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
204 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
206 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
209 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* + */
210 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
211 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
212 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
213 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
216 * specific LDAP instantiations of BER types we know about
219 /* Overview of LBER tag construction
226 * 1 0 = CONTEXT-SPECIFIC
233 * | 5 ... 1 | TAG-NUMBER
237 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
238 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
239 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
240 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
241 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
242 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
244 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
246 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
247 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
248 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
249 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
251 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
254 /* possible operations a client can invoke */
255 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
256 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
257 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
258 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
259 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
260 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
261 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
262 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
263 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
264 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
265 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
266 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
268 /* possible result types a server can return */
269 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
270 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
271 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
272 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
273 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
274 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
275 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
276 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
277 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
278 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
279 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
280 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
281 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
283 #define LDAP_RES_ANY (-1)
284 #define LDAP_RES_UNSOLICITED (0)
288 #define LDAP_SASL_SIMPLE ((char*)0)
289 #define LDAP_SASL_NULL ("")
292 /* authentication methods available */
293 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
294 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
295 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
296 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
297 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
298 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
302 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
303 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
304 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
305 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
306 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
307 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
308 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
309 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
310 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
311 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
313 /* extended filter component types */
314 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
315 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
316 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
317 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
319 /* substring filter component types */
320 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
321 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
322 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
325 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
326 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
327 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
328 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
330 /* substring filter component types */
331 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
332 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
333 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
336 * possible error codes we can return
339 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
341 #define LDAP_SUCCESS 0x00
342 #define LDAP_OPERATIONS_ERROR 0x01
343 #define LDAP_PROTOCOL_ERROR 0x02
344 #define LDAP_TIMELIMIT_EXCEEDED 0x03
345 #define LDAP_SIZELIMIT_EXCEEDED 0x04
346 #define LDAP_COMPARE_FALSE 0x05
347 #define LDAP_COMPARE_TRUE 0x06
348 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
349 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
350 #define LDAP_STRONG_AUTH_REQUIRED 0x08
351 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
353 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
354 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
355 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
356 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
357 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
359 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
361 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
362 #define LDAP_UNDEFINED_TYPE 0x11
363 #define LDAP_INAPPROPRIATE_MATCHING 0x12
364 #define LDAP_CONSTRAINT_VIOLATION 0x13
365 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
366 #define LDAP_INVALID_SYNTAX 0x15
368 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
370 #define LDAP_NO_SUCH_OBJECT 0x20
371 #define LDAP_ALIAS_PROBLEM 0x21
372 #define LDAP_INVALID_DN_SYNTAX 0x22
373 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
374 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
376 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
378 #define LDAP_INAPPROPRIATE_AUTH 0x30
379 #define LDAP_INVALID_CREDENTIALS 0x31
380 #define LDAP_INSUFFICIENT_ACCESS 0x32
382 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
384 #define LDAP_BUSY 0x33
385 #define LDAP_UNAVAILABLE 0x34
386 #define LDAP_UNWILLING_TO_PERFORM 0x35
387 #define LDAP_LOOP_DETECT 0x36
389 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
391 #define LDAP_NAMING_VIOLATION 0x40
392 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
393 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
394 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
395 #define LDAP_ALREADY_EXISTS 0x44
396 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
397 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
398 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
400 #define LDAP_OTHER 0x50
402 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
403 #define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
404 LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
406 /* reserved for APIs */
407 #define LDAP_SERVER_DOWN 0x51
408 #define LDAP_LOCAL_ERROR 0x52
409 #define LDAP_ENCODING_ERROR 0x53
410 #define LDAP_DECODING_ERROR 0x54
411 #define LDAP_TIMEOUT 0x55
412 #define LDAP_AUTH_UNKNOWN 0x56
413 #define LDAP_FILTER_ERROR 0x57
414 #define LDAP_USER_CANCELLED 0x58
415 #define LDAP_PARAM_ERROR 0x59
416 #define LDAP_NO_MEMORY 0x5a
418 /* used but not reserved for APIs */
419 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
420 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
421 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
422 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
423 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
424 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
425 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
428 * This structure represents both ldap messages and ldap responses.
429 * These are really the same, except in the case of search responses,
430 * where a response has multiple messages.
433 typedef struct ldapmsg LDAPMessage;
435 /* for modifications */
436 typedef struct ldapmod {
439 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
440 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
441 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
442 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
443 /* IMPORTANT: do not use code 0x1000 (or above),
444 * it is used internally by the backends!
445 * (see ldap/servers/slapd/slap.h)
451 struct berval **modv_bvals;
453 #define mod_values mod_vals.modv_strvals
454 #define mod_bvalues mod_vals.modv_bvals
458 * structure representing an ldap session which can
459 * encompass connections to multiple servers (in the
460 * face of referrals).
462 typedef struct ldap LDAP;
464 #define LDAP_DEREF_NEVER 0x00
465 #define LDAP_DEREF_SEARCHING 0x01
466 #define LDAP_DEREF_FINDING 0x02
467 #define LDAP_DEREF_ALWAYS 0x03
469 #define LDAP_NO_LIMIT 0
471 /* how many messages to retrieve results for */
472 #define LDAP_MSG_ONE 0x00
473 #define LDAP_MSG_ALL 0x01
474 #define LDAP_MSG_RECEIVED 0x02
477 * types for ldap URL handling
479 typedef struct ldap_url_desc {
480 struct ldap_url_desc *lud_next;
492 #define LDAP_URL_SUCCESS 0x00 /* Success */
493 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
494 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
496 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
497 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
498 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
499 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
500 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
501 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
502 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
503 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
506 * The API draft spec says we should declare (or cause to be declared)
507 * 'struct timeval'. We don't. See IETF LDAPext discussions.
515 ldap_get_option LDAP_P((
521 ldap_set_option LDAP_P((
524 LDAP_CONST void *invalue));
526 /* V3 REBIND Function Callback Prototype */
527 typedef int (LDAP_REBIND_PROC) LDAP_P((
528 LDAP *ld, LDAP_CONST char *url,
529 ber_tag_t request, ber_int_t msgid,
533 ldap_set_rebind_proc LDAP_P((
535 LDAP_REBIND_PROC *rebind_proc,
542 ldap_create_control LDAP_P((
543 LDAP_CONST char *requestOID,
546 LDAPControl **ctrlp ));
549 ldap_control_free LDAP_P((
550 LDAPControl *ctrl ));
553 ldap_controls_free LDAP_P((
554 LDAPControl **ctrls ));
560 ldap_domain2dn LDAP_P((
561 LDAP_CONST char* domain,
565 ldap_dn2domain LDAP_P((
570 ldap_domain2hostlist LDAP_P((
571 LDAP_CONST char *domain,
578 ldap_extended_operation LDAP_P((
580 LDAP_CONST char *reqoid,
581 struct berval *reqdata,
582 LDAPControl **serverctrls,
583 LDAPControl **clientctrls,
587 ldap_extended_operation_s LDAP_P((
589 LDAP_CONST char *reqoid,
590 struct berval *reqdata,
591 LDAPControl **serverctrls,
592 LDAPControl **clientctrls,
594 struct berval **retdatap ));
597 ldap_parse_extended_result LDAP_P((
601 struct berval **retdatap,
605 ldap_parse_extended_partial LDAP_P((
609 struct berval **retdatap,
610 LDAPControl ***serverctrls,
617 ldap_abandon_ext LDAP_P((
620 LDAPControl **serverctrls,
621 LDAPControl **clientctrls ));
624 ldap_abandon LDAP_P(( /* deprecated */
633 ldap_add_ext LDAP_P((
637 LDAPControl **serverctrls,
638 LDAPControl **clientctrls,
642 ldap_add_ext_s LDAP_P((
646 LDAPControl **serverctrls,
647 LDAPControl **clientctrls ));
650 ldap_add LDAP_P(( /* deprecated */
656 ldap_add_s LDAP_P(( /* deprecated */
666 ldap_sasl_bind LDAP_P((
669 LDAP_CONST char *mechanism,
671 LDAPControl **serverctrls,
672 LDAPControl **clientctrls,
675 /* Interaction flags (should be passed about in a control)
676 * Automatic (default): use defaults, prompt otherwise
677 * Interactive: prompt always
678 * Quiet: never prompt
680 #define LDAP_SASL_AUTOMATIC 0U
681 #define LDAP_SASL_INTERACTIVE 1U
682 #define LDAP_SASL_QUIET 2U
685 * V3 SASL Interaction Function Callback Prototype
686 * when using Cyrus SASL, interact is pointer to sasl_interact_t
687 * should likely passed in a control (and provided controls)
689 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
690 LDAP *ld, unsigned flags, void* defaults, void *interact ));
693 ldap_sasl_interactive_bind_s LDAP_P((
695 LDAP_CONST char *dn, /* usually NULL */
696 LDAP_CONST char *saslMechanism,
697 LDAPControl **serverControls,
698 LDAPControl **clientControls,
700 /* should be client controls */
702 LDAP_SASL_INTERACT_PROC *proc,
706 ldap_sasl_bind_s LDAP_P((
709 LDAP_CONST char *mechanism,
711 LDAPControl **serverctrls,
712 LDAPControl **clientctrls,
713 struct berval **servercredp ));
716 ldap_parse_sasl_bind_result LDAP_P((
719 struct berval **servercredp,
727 ldap_bind LDAP_P(( /* deprecated */
729 LDAP_CONST char *who,
730 LDAP_CONST char *passwd,
734 ldap_bind_s LDAP_P(( /* deprecated */
736 LDAP_CONST char *who,
737 LDAP_CONST char *cred,
744 ldap_simple_bind LDAP_P((
746 LDAP_CONST char *who,
747 LDAP_CONST char *passwd ));
750 ldap_simple_bind_s LDAP_P((
752 LDAP_CONST char *who,
753 LDAP_CONST char *passwd ));
761 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
763 LDAP_CONST char *who ));
766 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
768 LDAP_CONST char *who ));
771 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
773 LDAP_CONST char *who ));
776 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
778 LDAP_CONST char *who ));
781 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
783 LDAP_CONST char *who ));
790 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
793 ldap_disable_cache LDAP_P(( LDAP *ld ));
796 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
799 ldap_destroy_cache LDAP_P(( LDAP *ld ));
802 ldap_flush_cache LDAP_P(( LDAP *ld ));
805 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
808 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
815 ldap_compare_ext LDAP_P((
818 LDAP_CONST char *attr,
819 struct berval *bvalue,
820 LDAPControl **serverctrls,
821 LDAPControl **clientctrls,
825 ldap_compare_ext_s LDAP_P((
828 LDAP_CONST char *attr,
829 struct berval *bvalue,
830 LDAPControl **serverctrls,
831 LDAPControl **clientctrls ));
834 ldap_compare LDAP_P(( /* deprecated */
837 LDAP_CONST char *attr,
838 LDAP_CONST char *value ));
841 ldap_compare_s LDAP_P(( /* deprecated */
844 LDAP_CONST char *attr,
845 LDAP_CONST char *value ));
852 ldap_delete_ext LDAP_P((
855 LDAPControl **serverctrls,
856 LDAPControl **clientctrls,
860 ldap_delete_ext_s LDAP_P((
863 LDAPControl **serverctrls,
864 LDAPControl **clientctrls ));
867 ldap_delete LDAP_P(( /* deprecated */
869 LDAP_CONST char *dn ));
872 ldap_delete_s LDAP_P(( /* deprecated */
874 LDAP_CONST char *dn ));
881 ldap_parse_result LDAP_P((
888 LDAPControl ***serverctrls,
892 ldap_err2string LDAP_P((
896 ldap_result2error LDAP_P(( /* deprecated */
902 ldap_perror LDAP_P(( /* deprecated */
904 LDAP_CONST char *s ));
911 ldap_modify_ext LDAP_P((
915 LDAPControl **serverctrls,
916 LDAPControl **clientctrls,
920 ldap_modify_ext_s LDAP_P((
924 LDAPControl **serverctrls,
925 LDAPControl **clientctrls ));
928 ldap_modify LDAP_P(( /* deprecated */
934 ldap_modify_s LDAP_P(( /* deprecated */
947 LDAP_CONST char *newrdn,
948 LDAP_CONST char *newSuperior,
950 LDAPControl **sctrls,
951 LDAPControl **cctrls,
955 ldap_rename_s LDAP_P((
958 LDAP_CONST char *newrdn,
959 LDAP_CONST char *newSuperior,
961 LDAPControl **sctrls,
962 LDAPControl **cctrls ));
965 ldap_rename2 LDAP_P(( /* deprecated */
968 LDAP_CONST char *newrdn,
969 LDAP_CONST char *newSuperior,
973 ldap_rename2_s LDAP_P(( /* deprecated */
976 LDAP_CONST char *newrdn,
977 LDAP_CONST char *newSuperior,
981 ldap_modrdn LDAP_P(( /* deprecated */
984 LDAP_CONST char *newrdn ));
987 ldap_modrdn_s LDAP_P(( /* deprecated */
990 LDAP_CONST char *newrdn ));
993 ldap_modrdn2 LDAP_P(( /* deprecated */
996 LDAP_CONST char *newrdn,
1000 ldap_modrdn2_s LDAP_P(( /* deprecated */
1002 LDAP_CONST char *dn,
1003 LDAP_CONST char *newrdn,
1012 LDAP_CONST char *host,
1016 ldap_open LDAP_P(( /* deprecated */
1017 LDAP_CONST char *host,
1021 ldap_create LDAP_P((
1025 ldap_initialize LDAP_P((
1027 LDAP_CONST char *url ));
1030 ldap_start_tls_s LDAP_P((
1032 LDAPControl **serverctrls,
1033 LDAPControl **clientctrls ));
1038 LDAP_F( LDAPMessage * )
1039 ldap_first_message LDAP_P((
1041 LDAPMessage *chain ));
1043 LDAP_F( LDAPMessage * )
1044 ldap_next_message LDAP_P((
1046 LDAPMessage *msg ));
1049 ldap_count_messages LDAP_P((
1051 LDAPMessage *chain ));
1057 LDAP_F( LDAPMessage * )
1058 ldap_first_reference LDAP_P((
1060 LDAPMessage *chain ));
1062 LDAP_F( LDAPMessage * )
1063 ldap_next_reference LDAP_P((
1065 LDAPMessage *ref ));
1068 ldap_count_references LDAP_P((
1070 LDAPMessage *chain ));
1073 ldap_parse_reference LDAP_P((
1077 LDAPControl ***serverctrls,
1084 LDAP_F( LDAPMessage * )
1085 ldap_first_entry LDAP_P((
1087 LDAPMessage *chain ));
1089 LDAP_F( LDAPMessage * )
1090 ldap_next_entry LDAP_P((
1092 LDAPMessage *entry ));
1095 ldap_count_entries LDAP_P((
1097 LDAPMessage *chain ));
1100 ldap_get_entry_controls LDAP_P((
1103 LDAPControl ***serverctrls));
1109 LDAP_F( LDAPMessage * )
1110 ldap_delete_result_entry LDAP_P((
1115 ldap_add_result_entry LDAP_P((
1124 ldap_get_dn LDAP_P((
1126 LDAPMessage *entry ));
1128 typedef struct ldap_ava {
1129 struct berval la_attr;
1130 struct berval la_value;
1132 #define LDAP_AVA_STRING 0x0000U
1133 #define LDAP_AVA_BINARY 0x0001U
1134 #define LDAP_AVA_NONPRINTABLE 0x0002U
1139 typedef LDAPAVA** LDAPRDN;
1140 typedef LDAPRDN** LDAPDN;
1143 #define LDAP_DN_FORMAT_LDAP 0x0000U
1144 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1145 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1146 #define LDAP_DN_FORMAT_DCE 0x0030U
1147 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1148 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1149 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1150 #define LDAP_DN_FORMAT_MASK 0x00F0U
1153 #define LDAP_DN_PRETTY 0x0100U
1154 #define LDAP_DN_SKIP 0x0200U
1155 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1156 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1157 #define LDAP_DN_PEDANTIC 0xF000U
1160 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1162 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1164 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1173 ldap_str2dn LDAP_P((
1174 LDAP_CONST char *str,
1185 ldap_dn2str LDAP_P((
1191 ldap_bv2rdn LDAP_P((
1198 ldap_str2rdn LDAP_P((
1199 LDAP_CONST char *str,
1205 ldap_rdn2bv LDAP_P((
1211 ldap_rdn2str LDAP_P((
1217 ldap_dn_normalize LDAP_P((
1218 LDAP_CONST char *in, unsigned iflags,
1219 char **out, unsigned oflags ));
1222 ldap_dn2ufn LDAP_P(( /* deprecated */
1223 LDAP_CONST char *dn ));
1226 ldap_explode_dn LDAP_P(( /* deprecated */
1227 LDAP_CONST char *dn,
1231 ldap_explode_rdn LDAP_P(( /* deprecated */
1232 LDAP_CONST char *rdn,
1235 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1238 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1239 LDAPDN_rewrite_func *func, unsigned flags ));
1242 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1245 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1248 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1254 ldap_first_attribute LDAP_P((
1257 BerElement **ber ));
1260 ldap_next_attribute LDAP_P((
1269 LDAP_F( struct berval ** )
1270 ldap_get_values_len LDAP_P((
1273 LDAP_CONST char *target ));
1276 ldap_count_values_len LDAP_P((
1277 struct berval **vals ));
1280 ldap_value_free_len LDAP_P((
1281 struct berval **vals ));
1284 ldap_get_values LDAP_P(( /* deprecated */
1287 LDAP_CONST char *target ));
1290 ldap_count_values LDAP_P(( /* deprecated */
1294 ldap_value_free LDAP_P(( /* deprecated */
1301 ldap_result LDAP_P((
1305 struct timeval *timeout,
1306 LDAPMessage **result ));
1309 ldap_msgtype LDAP_P((
1317 ldap_msgfree LDAP_P((
1321 ldap_msgdelete LDAP_P((
1330 ldap_search_ext LDAP_P((
1332 LDAP_CONST char *base,
1334 LDAP_CONST char *filter,
1337 LDAPControl **serverctrls,
1338 LDAPControl **clientctrls,
1339 struct timeval *timeout,
1344 ldap_search_ext_s LDAP_P((
1346 LDAP_CONST char *base,
1348 LDAP_CONST char *filter,
1351 LDAPControl **serverctrls,
1352 LDAPControl **clientctrls,
1353 struct timeval *timeout,
1355 LDAPMessage **res ));
1358 ldap_search LDAP_P(( /* deprecated */
1360 LDAP_CONST char *base,
1362 LDAP_CONST char *filter,
1367 ldap_search_s LDAP_P(( /* deprecated */
1369 LDAP_CONST char *base,
1371 LDAP_CONST char *filter,
1374 LDAPMessage **res ));
1377 ldap_search_st LDAP_P(( /* deprecated */
1379 LDAP_CONST char *base,
1381 LDAP_CONST char *filter,
1384 struct timeval *timeout,
1385 LDAPMessage **res ));
1391 ldap_unbind LDAP_P(( /* deprecated */
1395 ldap_unbind_s LDAP_P(( /* deprecated */
1399 ldap_unbind_ext LDAP_P((
1401 LDAPControl **serverctrls,
1402 LDAPControl **clientctrls));
1405 ldap_unbind_ext_s LDAP_P((
1407 LDAPControl **serverctrls,
1408 LDAPControl **clientctrls));
1414 ldap_put_vrFilter LDAP_P((
1423 ldap_memalloc LDAP_P((
1427 ldap_memrealloc LDAP_P((
1432 ldap_memcalloc LDAP_P((
1437 ldap_memfree LDAP_P((
1441 ldap_memvfree LDAP_P((
1445 ldap_strdup LDAP_P((
1446 LDAP_CONST char * ));
1449 ldap_mods_free LDAP_P((
1458 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1459 LDAP_CONST char *left,
1460 LDAP_CONST char *right ));
1462 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1463 LDAP_CONST void *left,
1464 LDAP_CONST void *right ));
1466 LDAP_F( int ) /* deprecated */
1467 ldap_sort_entries LDAP_P(( LDAP *ld,
1468 LDAPMessage **chain,
1469 LDAP_CONST char *attr,
1470 LDAP_SORT_AD_CMP_PROC *cmp ));
1472 LDAP_F( int ) /* deprecated */
1473 ldap_sort_values LDAP_P((
1476 LDAP_SORT_AV_CMP_PROC *cmp ));
1478 LDAP_F( int ) /* deprecated */
1479 ldap_sort_strcasecmp LDAP_P((
1481 LDAP_CONST void *b ));
1488 ldap_is_ldap_url LDAP_P((
1489 LDAP_CONST char *url ));
1492 ldap_is_ldaps_url LDAP_P((
1493 LDAP_CONST char *url ));
1496 ldap_is_ldapi_url LDAP_P((
1497 LDAP_CONST char *url ));
1500 ldap_url_parse LDAP_P((
1501 LDAP_CONST char *url,
1502 LDAPURLDesc **ludpp ));
1505 ldap_url_desc2str LDAP_P((
1506 LDAPURLDesc *ludp ));
1509 ldap_free_urldesc LDAP_P((
1510 LDAPURLDesc *ludp ));
1516 * structure for a sort-key
1518 typedef struct ldapsortkey {
1519 char * attributeType;
1520 char * orderingRule;
1525 ldap_create_sort_keylist LDAP_P((
1526 LDAPSortKey ***sortKeyList,
1530 ldap_free_sort_keylist LDAP_P((
1531 LDAPSortKey **sortkeylist ));
1534 ldap_create_sort_control LDAP_P((
1536 LDAPSortKey **keyList,
1538 LDAPControl **ctrlp ));
1541 ldap_parse_sort_control LDAP_P((
1543 LDAPControl **ctrlp,
1544 unsigned long *result,
1545 char **attribute ));
1553 * structure for virtual list.
1555 typedef struct ldapvlvinfo {
1557 unsigned long ldvlv_before_count;
1558 unsigned long ldvlv_after_count;
1559 unsigned long ldvlv_offset;
1560 unsigned long ldvlv_count;
1561 struct berval *ldvlv_attrvalue;
1562 struct berval *ldvlv_context;
1563 void *ldvlv_extradata;
1567 ldap_create_vlv_control LDAP_P((
1569 LDAPVLVInfo *ldvlistp,
1570 LDAPControl **ctrlp ));
1573 ldap_parse_vlv_control LDAP_P((
1575 LDAPControl **ctrls,
1576 unsigned long *target_posp,
1577 unsigned long *list_countp,
1578 struct berval **contextp,
1583 #endif /* _LDAP_H */