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;
185 /* chase referrals client control (not yet implemented) */
186 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
187 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
188 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
191 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
192 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1"
193 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
195 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
196 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
197 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
198 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
201 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319"
204 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
205 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
206 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
207 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
209 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
211 /* LDAP Unsolicited Notifications */
212 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
213 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
215 /* LDAP Extended Operations */
216 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
218 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
219 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
220 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
221 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
222 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
224 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
227 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* + */
228 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
229 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
230 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
231 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
234 * specific LDAP instantiations of BER types we know about
237 /* Overview of LBER tag construction
244 * 1 0 = CONTEXT-SPECIFIC
251 * | 5 ... 1 | TAG-NUMBER
255 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
256 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
257 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
258 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
259 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
260 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
262 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
264 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
265 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
266 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
267 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
269 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
272 /* possible operations a client can invoke */
273 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
274 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
275 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
276 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
277 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
278 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
279 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
280 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
281 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
282 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
283 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
284 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
286 /* possible result types a server can return */
287 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
288 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
289 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
290 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
291 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
292 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
293 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
294 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
295 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
296 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
297 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
298 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
299 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
301 #define LDAP_RES_ANY (-1)
302 #define LDAP_RES_UNSOLICITED (0)
306 #define LDAP_SASL_SIMPLE ((char*)0)
307 #define LDAP_SASL_NULL ("")
310 /* authentication methods available */
311 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
312 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
313 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
314 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
315 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
316 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
320 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
321 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
322 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
323 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
324 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
325 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
326 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
327 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
328 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
329 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
331 /* extended filter component types */
332 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
333 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
334 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
335 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
337 /* substring filter component types */
338 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
339 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
340 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
343 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
344 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
345 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
346 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
348 /* substring filter component types */
349 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
350 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
351 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
354 * possible error codes we can return
357 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
359 #define LDAP_SUCCESS 0x00
360 #define LDAP_OPERATIONS_ERROR 0x01
361 #define LDAP_PROTOCOL_ERROR 0x02
362 #define LDAP_TIMELIMIT_EXCEEDED 0x03
363 #define LDAP_SIZELIMIT_EXCEEDED 0x04
364 #define LDAP_COMPARE_FALSE 0x05
365 #define LDAP_COMPARE_TRUE 0x06
366 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
367 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
368 #define LDAP_STRONG_AUTH_REQUIRED 0x08
369 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
371 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
372 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
373 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
374 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
375 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
377 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
379 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
380 #define LDAP_UNDEFINED_TYPE 0x11
381 #define LDAP_INAPPROPRIATE_MATCHING 0x12
382 #define LDAP_CONSTRAINT_VIOLATION 0x13
383 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
384 #define LDAP_INVALID_SYNTAX 0x15
386 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
388 #define LDAP_NO_SUCH_OBJECT 0x20
389 #define LDAP_ALIAS_PROBLEM 0x21
390 #define LDAP_INVALID_DN_SYNTAX 0x22
391 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
392 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
394 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
396 #define LDAP_INAPPROPRIATE_AUTH 0x30
397 #define LDAP_INVALID_CREDENTIALS 0x31
398 #define LDAP_INSUFFICIENT_ACCESS 0x32
400 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
402 #define LDAP_BUSY 0x33
403 #define LDAP_UNAVAILABLE 0x34
404 #define LDAP_UNWILLING_TO_PERFORM 0x35
405 #define LDAP_LOOP_DETECT 0x36
407 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
409 #define LDAP_NAMING_VIOLATION 0x40
410 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
411 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
412 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
413 #define LDAP_ALREADY_EXISTS 0x44
414 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
415 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
416 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
418 #define LDAP_OTHER 0x50
420 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
421 #define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
422 LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
424 /* reserved for APIs */
425 #define LDAP_SERVER_DOWN 0x51
426 #define LDAP_LOCAL_ERROR 0x52
427 #define LDAP_ENCODING_ERROR 0x53
428 #define LDAP_DECODING_ERROR 0x54
429 #define LDAP_TIMEOUT 0x55
430 #define LDAP_AUTH_UNKNOWN 0x56
431 #define LDAP_FILTER_ERROR 0x57
432 #define LDAP_USER_CANCELLED 0x58
433 #define LDAP_PARAM_ERROR 0x59
434 #define LDAP_NO_MEMORY 0x5a
436 /* used but not reserved for APIs */
437 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
438 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
439 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
440 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
441 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
442 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
443 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
446 * This structure represents both ldap messages and ldap responses.
447 * These are really the same, except in the case of search responses,
448 * where a response has multiple messages.
451 typedef struct ldapmsg LDAPMessage;
453 /* for modifications */
454 typedef struct ldapmod {
457 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
458 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
459 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
460 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
461 /* IMPORTANT: do not use code 0x1000 (or above),
462 * it is used internally by the backends!
463 * (see ldap/servers/slapd/slap.h)
469 struct berval **modv_bvals;
471 #define mod_values mod_vals.modv_strvals
472 #define mod_bvalues mod_vals.modv_bvals
476 * structure representing an ldap session which can
477 * encompass connections to multiple servers (in the
478 * face of referrals).
480 typedef struct ldap LDAP;
482 #define LDAP_DEREF_NEVER 0x00
483 #define LDAP_DEREF_SEARCHING 0x01
484 #define LDAP_DEREF_FINDING 0x02
485 #define LDAP_DEREF_ALWAYS 0x03
487 #define LDAP_NO_LIMIT 0
489 /* how many messages to retrieve results for */
490 #define LDAP_MSG_ONE 0x00
491 #define LDAP_MSG_ALL 0x01
492 #define LDAP_MSG_RECEIVED 0x02
495 * types for ldap URL handling
497 typedef struct ldap_url_desc {
498 struct ldap_url_desc *lud_next;
510 #define LDAP_URL_SUCCESS 0x00 /* Success */
511 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
512 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
514 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
515 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
516 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
517 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
518 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
519 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
520 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
521 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
524 * The API draft spec says we should declare (or cause to be declared)
525 * 'struct timeval'. We don't. See IETF LDAPext discussions.
533 ldap_get_option LDAP_P((
539 ldap_set_option LDAP_P((
542 LDAP_CONST void *invalue));
544 /* V3 REBIND Function Callback Prototype */
545 typedef int (LDAP_REBIND_PROC) LDAP_P((
546 LDAP *ld, LDAP_CONST char *url,
547 ber_tag_t request, ber_int_t msgid,
551 ldap_set_rebind_proc LDAP_P((
553 LDAP_REBIND_PROC *rebind_proc,
560 ldap_create_control LDAP_P((
561 LDAP_CONST char *requestOID,
564 LDAPControl **ctrlp ));
567 ldap_control_free LDAP_P((
568 LDAPControl *ctrl ));
571 ldap_controls_free LDAP_P((
572 LDAPControl **ctrls ));
578 ldap_domain2dn LDAP_P((
579 LDAP_CONST char* domain,
583 ldap_dn2domain LDAP_P((
588 ldap_domain2hostlist LDAP_P((
589 LDAP_CONST char *domain,
596 ldap_extended_operation LDAP_P((
598 LDAP_CONST char *reqoid,
599 struct berval *reqdata,
600 LDAPControl **serverctrls,
601 LDAPControl **clientctrls,
605 ldap_extended_operation_s LDAP_P((
607 LDAP_CONST char *reqoid,
608 struct berval *reqdata,
609 LDAPControl **serverctrls,
610 LDAPControl **clientctrls,
612 struct berval **retdatap ));
615 ldap_parse_extended_result LDAP_P((
619 struct berval **retdatap,
623 ldap_parse_extended_partial LDAP_P((
627 struct berval **retdatap,
628 LDAPControl ***serverctrls,
635 ldap_abandon_ext LDAP_P((
638 LDAPControl **serverctrls,
639 LDAPControl **clientctrls ));
642 ldap_abandon LDAP_P(( /* deprecated */
651 ldap_add_ext LDAP_P((
655 LDAPControl **serverctrls,
656 LDAPControl **clientctrls,
660 ldap_add_ext_s LDAP_P((
664 LDAPControl **serverctrls,
665 LDAPControl **clientctrls ));
668 ldap_add LDAP_P(( /* deprecated */
674 ldap_add_s LDAP_P(( /* deprecated */
684 ldap_sasl_bind LDAP_P((
687 LDAP_CONST char *mechanism,
689 LDAPControl **serverctrls,
690 LDAPControl **clientctrls,
693 /* Interaction flags (should be passed about in a control)
694 * Automatic (default): use defaults, prompt otherwise
695 * Interactive: prompt always
696 * Quiet: never prompt
698 #define LDAP_SASL_AUTOMATIC 0U
699 #define LDAP_SASL_INTERACTIVE 1U
700 #define LDAP_SASL_QUIET 2U
703 * V3 SASL Interaction Function Callback Prototype
704 * when using Cyrus SASL, interact is pointer to sasl_interact_t
705 * should likely passed in a control (and provided controls)
707 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
708 LDAP *ld, unsigned flags, void* defaults, void *interact ));
711 ldap_sasl_interactive_bind_s LDAP_P((
713 LDAP_CONST char *dn, /* usually NULL */
714 LDAP_CONST char *saslMechanism,
715 LDAPControl **serverControls,
716 LDAPControl **clientControls,
718 /* should be client controls */
720 LDAP_SASL_INTERACT_PROC *proc,
724 ldap_sasl_bind_s LDAP_P((
727 LDAP_CONST char *mechanism,
729 LDAPControl **serverctrls,
730 LDAPControl **clientctrls,
731 struct berval **servercredp ));
734 ldap_parse_sasl_bind_result LDAP_P((
737 struct berval **servercredp,
745 ldap_bind LDAP_P(( /* deprecated */
747 LDAP_CONST char *who,
748 LDAP_CONST char *passwd,
752 ldap_bind_s LDAP_P(( /* deprecated */
754 LDAP_CONST char *who,
755 LDAP_CONST char *cred,
762 ldap_simple_bind LDAP_P((
764 LDAP_CONST char *who,
765 LDAP_CONST char *passwd ));
768 ldap_simple_bind_s LDAP_P((
770 LDAP_CONST char *who,
771 LDAP_CONST char *passwd ));
779 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
781 LDAP_CONST char *who ));
784 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
786 LDAP_CONST char *who ));
789 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
791 LDAP_CONST char *who ));
794 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
796 LDAP_CONST char *who ));
799 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
801 LDAP_CONST char *who ));
808 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
811 ldap_disable_cache LDAP_P(( LDAP *ld ));
814 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
817 ldap_destroy_cache LDAP_P(( LDAP *ld ));
820 ldap_flush_cache LDAP_P(( LDAP *ld ));
823 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
826 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
833 ldap_compare_ext LDAP_P((
836 LDAP_CONST char *attr,
837 struct berval *bvalue,
838 LDAPControl **serverctrls,
839 LDAPControl **clientctrls,
843 ldap_compare_ext_s LDAP_P((
846 LDAP_CONST char *attr,
847 struct berval *bvalue,
848 LDAPControl **serverctrls,
849 LDAPControl **clientctrls ));
852 ldap_compare LDAP_P(( /* deprecated */
855 LDAP_CONST char *attr,
856 LDAP_CONST char *value ));
859 ldap_compare_s LDAP_P(( /* deprecated */
862 LDAP_CONST char *attr,
863 LDAP_CONST char *value ));
870 ldap_delete_ext LDAP_P((
873 LDAPControl **serverctrls,
874 LDAPControl **clientctrls,
878 ldap_delete_ext_s LDAP_P((
881 LDAPControl **serverctrls,
882 LDAPControl **clientctrls ));
885 ldap_delete LDAP_P(( /* deprecated */
887 LDAP_CONST char *dn ));
890 ldap_delete_s LDAP_P(( /* deprecated */
892 LDAP_CONST char *dn ));
899 ldap_parse_result LDAP_P((
906 LDAPControl ***serverctrls,
910 ldap_err2string LDAP_P((
914 ldap_result2error LDAP_P(( /* deprecated */
920 ldap_perror LDAP_P(( /* deprecated */
922 LDAP_CONST char *s ));
929 ldap_modify_ext LDAP_P((
933 LDAPControl **serverctrls,
934 LDAPControl **clientctrls,
938 ldap_modify_ext_s LDAP_P((
942 LDAPControl **serverctrls,
943 LDAPControl **clientctrls ));
946 ldap_modify LDAP_P(( /* deprecated */
952 ldap_modify_s LDAP_P(( /* deprecated */
965 LDAP_CONST char *newrdn,
966 LDAP_CONST char *newSuperior,
968 LDAPControl **sctrls,
969 LDAPControl **cctrls,
973 ldap_rename_s LDAP_P((
976 LDAP_CONST char *newrdn,
977 LDAP_CONST char *newSuperior,
979 LDAPControl **sctrls,
980 LDAPControl **cctrls ));
983 ldap_rename2 LDAP_P(( /* deprecated */
986 LDAP_CONST char *newrdn,
987 LDAP_CONST char *newSuperior,
991 ldap_rename2_s LDAP_P(( /* deprecated */
994 LDAP_CONST char *newrdn,
995 LDAP_CONST char *newSuperior,
999 ldap_modrdn LDAP_P(( /* deprecated */
1001 LDAP_CONST char *dn,
1002 LDAP_CONST char *newrdn ));
1005 ldap_modrdn_s LDAP_P(( /* deprecated */
1007 LDAP_CONST char *dn,
1008 LDAP_CONST char *newrdn ));
1011 ldap_modrdn2 LDAP_P(( /* deprecated */
1013 LDAP_CONST char *dn,
1014 LDAP_CONST char *newrdn,
1015 int deleteoldrdn ));
1018 ldap_modrdn2_s LDAP_P(( /* deprecated */
1020 LDAP_CONST char *dn,
1021 LDAP_CONST char *newrdn,
1030 LDAP_CONST char *host,
1034 ldap_open LDAP_P(( /* deprecated */
1035 LDAP_CONST char *host,
1039 ldap_create LDAP_P((
1043 ldap_initialize LDAP_P((
1045 LDAP_CONST char *url ));
1048 ldap_start_tls_s LDAP_P((
1050 LDAPControl **serverctrls,
1051 LDAPControl **clientctrls ));
1056 LDAP_F( LDAPMessage * )
1057 ldap_first_message LDAP_P((
1059 LDAPMessage *chain ));
1061 LDAP_F( LDAPMessage * )
1062 ldap_next_message LDAP_P((
1064 LDAPMessage *msg ));
1067 ldap_count_messages LDAP_P((
1069 LDAPMessage *chain ));
1075 LDAP_F( LDAPMessage * )
1076 ldap_first_reference LDAP_P((
1078 LDAPMessage *chain ));
1080 LDAP_F( LDAPMessage * )
1081 ldap_next_reference LDAP_P((
1083 LDAPMessage *ref ));
1086 ldap_count_references LDAP_P((
1088 LDAPMessage *chain ));
1091 ldap_parse_reference LDAP_P((
1095 LDAPControl ***serverctrls,
1102 LDAP_F( LDAPMessage * )
1103 ldap_first_entry LDAP_P((
1105 LDAPMessage *chain ));
1107 LDAP_F( LDAPMessage * )
1108 ldap_next_entry LDAP_P((
1110 LDAPMessage *entry ));
1113 ldap_count_entries LDAP_P((
1115 LDAPMessage *chain ));
1118 ldap_get_entry_controls LDAP_P((
1121 LDAPControl ***serverctrls));
1127 LDAP_F( LDAPMessage * )
1128 ldap_delete_result_entry LDAP_P((
1133 ldap_add_result_entry LDAP_P((
1142 ldap_get_dn LDAP_P((
1144 LDAPMessage *entry ));
1146 typedef struct ldap_ava {
1147 struct berval la_attr;
1148 struct berval la_value;
1150 #define LDAP_AVA_STRING 0x0000U
1151 #define LDAP_AVA_BINARY 0x0001U
1152 #define LDAP_AVA_NONPRINTABLE 0x0002U
1157 typedef LDAPAVA** LDAPRDN;
1158 typedef LDAPRDN** LDAPDN;
1161 #define LDAP_DN_FORMAT_LDAP 0x0000U
1162 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1163 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1164 #define LDAP_DN_FORMAT_DCE 0x0030U
1165 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1166 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1167 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1168 #define LDAP_DN_FORMAT_MASK 0x00F0U
1171 #define LDAP_DN_PRETTY 0x0100U
1172 #define LDAP_DN_SKIP 0x0200U
1173 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1174 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1175 #define LDAP_DN_PEDANTIC 0xF000U
1178 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1180 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1182 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1191 ldap_str2dn LDAP_P((
1192 LDAP_CONST char *str,
1203 ldap_dn2str LDAP_P((
1209 ldap_bv2rdn LDAP_P((
1216 ldap_str2rdn LDAP_P((
1217 LDAP_CONST char *str,
1223 ldap_rdn2bv LDAP_P((
1229 ldap_rdn2str LDAP_P((
1235 ldap_dn_normalize LDAP_P((
1236 LDAP_CONST char *in, unsigned iflags,
1237 char **out, unsigned oflags ));
1240 ldap_dn2ufn LDAP_P(( /* deprecated */
1241 LDAP_CONST char *dn ));
1244 ldap_explode_dn LDAP_P(( /* deprecated */
1245 LDAP_CONST char *dn,
1249 ldap_explode_rdn LDAP_P(( /* deprecated */
1250 LDAP_CONST char *rdn,
1253 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1256 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1257 LDAPDN_rewrite_func *func, unsigned flags ));
1260 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1263 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1266 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1272 ldap_first_attribute LDAP_P((
1275 BerElement **ber ));
1278 ldap_next_attribute LDAP_P((
1287 LDAP_F( struct berval ** )
1288 ldap_get_values_len LDAP_P((
1291 LDAP_CONST char *target ));
1294 ldap_count_values_len LDAP_P((
1295 struct berval **vals ));
1298 ldap_value_free_len LDAP_P((
1299 struct berval **vals ));
1302 ldap_get_values LDAP_P(( /* deprecated */
1305 LDAP_CONST char *target ));
1308 ldap_count_values LDAP_P(( /* deprecated */
1312 ldap_value_free LDAP_P(( /* deprecated */
1319 ldap_result LDAP_P((
1323 struct timeval *timeout,
1324 LDAPMessage **result ));
1327 ldap_msgtype LDAP_P((
1335 ldap_msgfree LDAP_P((
1339 ldap_msgdelete LDAP_P((
1348 ldap_search_ext LDAP_P((
1350 LDAP_CONST char *base,
1352 LDAP_CONST char *filter,
1355 LDAPControl **serverctrls,
1356 LDAPControl **clientctrls,
1357 struct timeval *timeout,
1362 ldap_search_ext_s LDAP_P((
1364 LDAP_CONST char *base,
1366 LDAP_CONST char *filter,
1369 LDAPControl **serverctrls,
1370 LDAPControl **clientctrls,
1371 struct timeval *timeout,
1373 LDAPMessage **res ));
1376 ldap_search LDAP_P(( /* deprecated */
1378 LDAP_CONST char *base,
1380 LDAP_CONST char *filter,
1385 ldap_search_s LDAP_P(( /* deprecated */
1387 LDAP_CONST char *base,
1389 LDAP_CONST char *filter,
1392 LDAPMessage **res ));
1395 ldap_search_st LDAP_P(( /* deprecated */
1397 LDAP_CONST char *base,
1399 LDAP_CONST char *filter,
1402 struct timeval *timeout,
1403 LDAPMessage **res ));
1409 ldap_unbind LDAP_P(( /* deprecated */
1413 ldap_unbind_s LDAP_P(( /* deprecated */
1417 ldap_unbind_ext LDAP_P((
1419 LDAPControl **serverctrls,
1420 LDAPControl **clientctrls));
1423 ldap_unbind_ext_s LDAP_P((
1425 LDAPControl **serverctrls,
1426 LDAPControl **clientctrls));
1432 ldap_put_vrFilter LDAP_P((
1441 ldap_memalloc LDAP_P((
1445 ldap_memrealloc LDAP_P((
1450 ldap_memcalloc LDAP_P((
1455 ldap_memfree LDAP_P((
1459 ldap_memvfree LDAP_P((
1463 ldap_strdup LDAP_P((
1464 LDAP_CONST char * ));
1467 ldap_mods_free LDAP_P((
1476 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1477 LDAP_CONST char *left,
1478 LDAP_CONST char *right ));
1480 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1481 LDAP_CONST void *left,
1482 LDAP_CONST void *right ));
1484 LDAP_F( int ) /* deprecated */
1485 ldap_sort_entries LDAP_P(( LDAP *ld,
1486 LDAPMessage **chain,
1487 LDAP_CONST char *attr,
1488 LDAP_SORT_AD_CMP_PROC *cmp ));
1490 LDAP_F( int ) /* deprecated */
1491 ldap_sort_values LDAP_P((
1494 LDAP_SORT_AV_CMP_PROC *cmp ));
1496 LDAP_F( int ) /* deprecated */
1497 ldap_sort_strcasecmp LDAP_P((
1499 LDAP_CONST void *b ));
1506 ldap_is_ldap_url LDAP_P((
1507 LDAP_CONST char *url ));
1510 ldap_is_ldaps_url LDAP_P((
1511 LDAP_CONST char *url ));
1514 ldap_is_ldapi_url LDAP_P((
1515 LDAP_CONST char *url ));
1518 ldap_url_parse LDAP_P((
1519 LDAP_CONST char *url,
1520 LDAPURLDesc **ludpp ));
1523 ldap_url_desc2str LDAP_P((
1524 LDAPURLDesc *ludp ));
1527 ldap_free_urldesc LDAP_P((
1528 LDAPURLDesc *ludp ));
1534 * structure for a sort-key
1536 typedef struct ldapsortkey {
1537 char * attributeType;
1538 char * orderingRule;
1543 ldap_create_sort_keylist LDAP_P((
1544 LDAPSortKey ***sortKeyList,
1548 ldap_free_sort_keylist LDAP_P((
1549 LDAPSortKey **sortkeylist ));
1552 ldap_create_sort_control LDAP_P((
1554 LDAPSortKey **keyList,
1556 LDAPControl **ctrlp ));
1559 ldap_parse_sort_control LDAP_P((
1561 LDAPControl **ctrlp,
1562 unsigned long *result,
1563 char **attribute ));
1571 * structure for virtual list.
1573 typedef struct ldapvlvinfo {
1575 unsigned long ldvlv_before_count;
1576 unsigned long ldvlv_after_count;
1577 unsigned long ldvlv_offset;
1578 unsigned long ldvlv_count;
1579 struct berval *ldvlv_attrvalue;
1580 struct berval *ldvlv_context;
1581 void *ldvlv_extradata;
1585 ldap_create_vlv_control LDAP_P((
1587 LDAPVLVInfo *ldvlistp,
1588 LDAPControl **ctrlp ));
1591 ldap_parse_vlv_control LDAP_P((
1593 LDAPControl **ctrls,
1594 unsigned long *target_posp,
1595 unsigned long *list_countp,
1596 struct berval **contextp,
1601 #endif /* _LDAP_H */