3 * Copyright 1998-2001 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"
50 /* We'll eventually release as 20000 */
52 /* OpenLDAP API Features */
53 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
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
125 #define LDAP_OPT_X_TLS_RANDOM_FILE 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;
183 /* chase referrals controls */
184 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
185 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
186 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
188 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
190 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
191 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
192 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
193 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
195 /* Experimental Controls */
197 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
198 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
199 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
200 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
202 /* LDAP Unsolicited Notifications */
203 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
204 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
206 /* LDAP Extended Operations */
207 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
209 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
210 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
211 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
212 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
213 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
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 + primitive */
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 /* not listed in v3 */
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 */
404 /* reserved for APIs */
405 #define LDAP_SERVER_DOWN 0x51
406 #define LDAP_LOCAL_ERROR 0x52
407 #define LDAP_ENCODING_ERROR 0x53
408 #define LDAP_DECODING_ERROR 0x54
409 #define LDAP_TIMEOUT 0x55
410 #define LDAP_AUTH_UNKNOWN 0x56
411 #define LDAP_FILTER_ERROR 0x57
412 #define LDAP_USER_CANCELLED 0x58
413 #define LDAP_PARAM_ERROR 0x59
414 #define LDAP_NO_MEMORY 0x5a
416 /* used but not reserved for APIs */
417 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
418 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
419 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
420 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
421 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
422 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
423 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
426 * This structure represents both ldap messages and ldap responses.
427 * These are really the same, except in the case of search responses,
428 * where a response has multiple messages.
431 typedef struct ldapmsg LDAPMessage;
433 /* for modifications */
434 typedef struct ldapmod {
437 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
438 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
439 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
440 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
441 /* IMPORTANT: do not use code 0x1000 (or above),
442 * it is used internally by the backends!
443 * (see ldap/servers/slapd/slap.h)
449 struct berval **modv_bvals;
451 #define mod_values mod_vals.modv_strvals
452 #define mod_bvalues mod_vals.modv_bvals
456 * structures for ldap getfilter routines
459 typedef struct ldap_filt_info {
464 struct ldap_filt_info *lfi_next;
467 typedef struct ldap_filt_list {
471 LDAPFiltInfo *lfl_ilist;
472 struct ldap_filt_list *lfl_next;
476 #define LDAP_FILT_MAXSIZ 1024
478 typedef struct ldap_filt_desc {
479 LDAPFiltList *lfd_filtlist;
480 LDAPFiltInfo *lfd_curfip;
481 LDAPFiltInfo lfd_retfi;
482 char lfd_filter[ LDAP_FILT_MAXSIZ ];
484 char *lfd_curvalcopy;
485 char **lfd_curvalwords;
486 char *lfd_filtprefix;
487 char *lfd_filtsuffix;
492 * structure representing an ldap session which can
493 * encompass connections to multiple servers (in the
494 * face of referrals).
496 typedef struct ldap LDAP;
498 #define LDAP_DEREF_NEVER 0x00
499 #define LDAP_DEREF_SEARCHING 0x01
500 #define LDAP_DEREF_FINDING 0x02
501 #define LDAP_DEREF_ALWAYS 0x03
503 #define LDAP_NO_LIMIT 0
505 /* how many messages to retrieve results for */
506 #define LDAP_MSG_ONE 0x00
507 #define LDAP_MSG_ALL 0x01
508 #define LDAP_MSG_RECEIVED 0x02
511 * structure for ldap friendly mapping routines
514 typedef struct ldap_friendly {
520 * types for ldap URL handling
522 typedef struct ldap_url_desc {
523 struct ldap_url_desc *lud_next;
535 #define LDAP_URL_SUCCESS 0x00 /* Success */
536 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
537 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
539 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
540 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
541 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
542 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
543 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
544 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
545 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
546 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
549 * The API draft spec says we should declare (or cause to be declared)
550 * 'struct timeval'. We don't. See IETF LDAPext discussions.
558 ldap_get_option LDAP_P((
564 ldap_set_option LDAP_P((
567 LDAP_CONST void *invalue));
569 /* V3 REBIND Function Callback Prototype */
570 typedef int (LDAP_REBIND_PROC) LDAP_P((
571 LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
574 ldap_set_rebind_proc LDAP_P((
576 LDAP_REBIND_PROC *ldap_proc));
582 ldap_create_control LDAP_P((
583 const char *requestOID,
586 LDAPControl **ctrlp ));
589 ldap_control_free LDAP_P((
590 LDAPControl *ctrl ));
593 ldap_controls_free LDAP_P((
594 LDAPControl **ctrls ));
600 ldap_domain2dn LDAP_P((
601 LDAP_CONST char* domain,
605 ldap_dn2domain LDAP_P((
610 ldap_domain2hostlist LDAP_P((
611 LDAP_CONST char *domain,
618 ldap_extended_operation LDAP_P((
620 LDAP_CONST char *reqoid,
621 struct berval *reqdata,
622 LDAPControl **serverctrls,
623 LDAPControl **clientctrls,
627 ldap_extended_operation_s LDAP_P((
629 LDAP_CONST char *reqoid,
630 struct berval *reqdata,
631 LDAPControl **serverctrls,
632 LDAPControl **clientctrls,
634 struct berval **retdatap ));
637 ldap_parse_extended_result LDAP_P((
641 struct berval **retdatap,
645 ldap_parse_extended_partial LDAP_P((
649 struct berval **retdatap,
650 LDAPControl ***serverctrls,
657 ldap_abandon_ext LDAP_P((
660 LDAPControl **serverctrls,
661 LDAPControl **clientctrls ));
664 ldap_abandon LDAP_P(( /* deprecated */
673 ldap_add_ext LDAP_P((
677 LDAPControl **serverctrls,
678 LDAPControl **clientctrls,
682 ldap_add_ext_s LDAP_P((
686 LDAPControl **serverctrls,
687 LDAPControl **clientctrls ));
690 ldap_add LDAP_P(( /* deprecated */
696 ldap_add_s LDAP_P(( /* deprecated */
706 ldap_sasl_bind LDAP_P((
709 LDAP_CONST char *mechanism,
711 LDAPControl **serverctrls,
712 LDAPControl **clientctrls,
715 /* Interaction flags (should be passed about in a control)
716 * Automatic (default): use defaults, prompt otherwise
717 * Interactive: prompt always
718 * Quiet: never prompt
720 #define LDAP_SASL_AUTOMATIC 0U
721 #define LDAP_SASL_INTERACTIVE 1U
722 #define LDAP_SASL_QUIET 2U
725 * V3 SASL Interaction Function Callback Prototype
726 * when using Cyrus SASL, interact is pointer to sasl_interact_t
727 * should likely passed in a control (and provided controls)
729 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
730 LDAP *ld, unsigned flags, void* defaults, void *interact ));
733 ldap_sasl_interactive_bind_s LDAP_P((
735 LDAP_CONST char *dn, /* usually NULL */
736 LDAP_CONST char *saslMechanism,
737 LDAPControl **serverControls,
738 LDAPControl **clientControls,
740 /* should be client controls */
742 LDAP_SASL_INTERACT_PROC *proc,
746 ldap_sasl_bind_s LDAP_P((
749 LDAP_CONST char *mechanism,
751 LDAPControl **serverctrls,
752 LDAPControl **clientctrls,
753 struct berval **servercredp ));
756 ldap_parse_sasl_bind_result LDAP_P((
759 struct berval **servercredp,
767 ldap_bind LDAP_P(( /* deprecated */
769 LDAP_CONST char *who,
770 LDAP_CONST char *passwd,
774 ldap_bind_s LDAP_P(( /* deprecated */
776 LDAP_CONST char *who,
777 LDAP_CONST char *cred,
784 ldap_simple_bind LDAP_P((
786 LDAP_CONST char *who,
787 LDAP_CONST char *passwd ));
790 ldap_simple_bind_s LDAP_P((
792 LDAP_CONST char *who,
793 LDAP_CONST char *passwd ));
801 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
803 LDAP_CONST char *who ));
806 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
808 LDAP_CONST char *who ));
811 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
813 LDAP_CONST char *who ));
816 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
818 LDAP_CONST char *who ));
821 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
823 LDAP_CONST char *who ));
830 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
833 ldap_disable_cache LDAP_P(( LDAP *ld ));
836 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
839 ldap_destroy_cache LDAP_P(( LDAP *ld ));
842 ldap_flush_cache LDAP_P(( LDAP *ld ));
845 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
848 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
855 ldap_compare_ext LDAP_P((
858 LDAP_CONST char *attr,
859 struct berval *bvalue,
860 LDAPControl **serverctrls,
861 LDAPControl **clientctrls,
865 ldap_compare_ext_s LDAP_P((
868 LDAP_CONST char *attr,
869 struct berval *bvalue,
870 LDAPControl **serverctrls,
871 LDAPControl **clientctrls ));
874 ldap_compare LDAP_P(( /* deprecated */
877 LDAP_CONST char *attr,
878 LDAP_CONST char *value ));
881 ldap_compare_s LDAP_P(( /* deprecated */
884 LDAP_CONST char *attr,
885 LDAP_CONST char *value ));
892 ldap_delete_ext LDAP_P((
895 LDAPControl **serverctrls,
896 LDAPControl **clientctrls,
900 ldap_delete_ext_s LDAP_P((
903 LDAPControl **serverctrls,
904 LDAPControl **clientctrls ));
907 ldap_delete LDAP_P(( /* deprecated */
909 LDAP_CONST char *dn ));
912 ldap_delete_s LDAP_P(( /* deprecated */
914 LDAP_CONST char *dn ));
921 ldap_parse_result LDAP_P((
928 LDAPControl ***serverctrls,
932 ldap_err2string LDAP_P((
936 ldap_result2error LDAP_P(( /* deprecated */
942 ldap_perror LDAP_P(( /* deprecated */
944 LDAP_CONST char *s ));
951 ldap_modify_ext LDAP_P((
955 LDAPControl **serverctrls,
956 LDAPControl **clientctrls,
960 ldap_modify_ext_s LDAP_P((
964 LDAPControl **serverctrls,
965 LDAPControl **clientctrls ));
968 ldap_modify LDAP_P(( /* deprecated */
974 ldap_modify_s LDAP_P(( /* deprecated */
987 LDAP_CONST char *newrdn,
988 LDAP_CONST char *newSuperior,
990 LDAPControl **sctrls,
991 LDAPControl **cctrls,
995 ldap_rename_s LDAP_P((
998 LDAP_CONST char *newrdn,
999 LDAP_CONST char *newSuperior,
1001 LDAPControl **sctrls,
1002 LDAPControl **cctrls ));
1005 ldap_rename2 LDAP_P(( /* deprecated */
1007 LDAP_CONST char *dn,
1008 LDAP_CONST char *newrdn,
1009 LDAP_CONST char *newSuperior,
1010 int deleteoldrdn ));
1013 ldap_rename2_s LDAP_P(( /* deprecated */
1015 LDAP_CONST char *dn,
1016 LDAP_CONST char *newrdn,
1017 LDAP_CONST char *newSuperior,
1018 int deleteoldrdn ));
1021 ldap_modrdn LDAP_P(( /* deprecated */
1023 LDAP_CONST char *dn,
1024 LDAP_CONST char *newrdn ));
1027 ldap_modrdn_s LDAP_P(( /* deprecated */
1029 LDAP_CONST char *dn,
1030 LDAP_CONST char *newrdn ));
1033 ldap_modrdn2 LDAP_P(( /* deprecated */
1035 LDAP_CONST char *dn,
1036 LDAP_CONST char *newrdn,
1037 int deleteoldrdn ));
1040 ldap_modrdn2_s LDAP_P(( /* deprecated */
1042 LDAP_CONST char *dn,
1043 LDAP_CONST char *newrdn,
1052 LDAP_CONST char *host,
1056 ldap_open LDAP_P(( /* deprecated */
1057 LDAP_CONST char *host,
1061 ldap_create LDAP_P((
1065 ldap_initialize LDAP_P((
1067 LDAP_CONST char *url ));
1070 ldap_start_tls_s LDAP_P((
1072 LDAPControl **serverctrls,
1073 LDAPControl **clientctrls ));
1078 LDAP_F( LDAPMessage *)
1079 ldap_first_message LDAP_P((
1081 LDAPMessage *chain ));
1083 LDAP_F( LDAPMessage *)
1084 ldap_next_message LDAP_P((
1086 LDAPMessage *msg ));
1089 ldap_count_messages LDAP_P((
1091 LDAPMessage *chain ));
1097 LDAP_F( LDAPMessage *)
1098 ldap_first_reference LDAP_P((
1100 LDAPMessage *chain ));
1102 LDAP_F( LDAPMessage *)
1103 ldap_next_reference LDAP_P((
1105 LDAPMessage *ref ));
1108 ldap_count_references LDAP_P((
1110 LDAPMessage *chain ));
1113 ldap_parse_reference LDAP_P((
1117 LDAPControl ***serverctrls,
1124 LDAP_F( LDAPMessage *)
1125 ldap_first_entry LDAP_P((
1127 LDAPMessage *chain ));
1129 LDAP_F( LDAPMessage *)
1130 ldap_next_entry LDAP_P((
1132 LDAPMessage *entry ));
1135 ldap_count_entries LDAP_P((
1137 LDAPMessage *chain ));
1140 ldap_get_entry_controls LDAP_P((
1143 LDAPControl ***serverctrls));
1149 LDAP_F( LDAPMessage *)
1150 ldap_delete_result_entry LDAP_P((
1155 ldap_add_result_entry LDAP_P((
1164 ldap_get_dn LDAP_P((
1166 LDAPMessage *entry ));
1169 ldap_dn2ufn LDAP_P((
1170 LDAP_CONST char *dn ));
1173 ldap_explode_dn LDAP_P((
1174 LDAP_CONST char *dn,
1178 ldap_explode_rdn LDAP_P((
1179 LDAP_CONST char *rdn,
1183 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1186 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1192 ldap_first_attribute LDAP_P((
1195 BerElement **ber ));
1198 ldap_next_attribute LDAP_P((
1208 ldap_get_values LDAP_P((
1211 LDAP_CONST char *target ));
1213 LDAP_F( struct berval **)
1214 ldap_get_values_len LDAP_P((
1217 LDAP_CONST char *target ));
1220 ldap_count_values LDAP_P((
1224 ldap_count_values_len LDAP_P((
1225 struct berval **vals ));
1228 ldap_value_free LDAP_P((
1232 ldap_value_free_len LDAP_P((
1233 struct berval **vals ));
1239 ldap_result LDAP_P((
1243 struct timeval *timeout,
1244 LDAPMessage **result ));
1247 ldap_msgtype LDAP_P((
1255 ldap_msgfree LDAP_P((
1259 ldap_msgdelete LDAP_P((
1268 ldap_search_ext LDAP_P((
1270 LDAP_CONST char *base,
1272 LDAP_CONST char *filter,
1275 LDAPControl **serverctrls,
1276 LDAPControl **clientctrls,
1277 struct timeval *timeout,
1282 ldap_search_ext_s LDAP_P((
1284 LDAP_CONST char *base,
1286 LDAP_CONST char *filter,
1289 LDAPControl **serverctrls,
1290 LDAPControl **clientctrls,
1291 struct timeval *timeout,
1293 LDAPMessage **res ));
1296 ldap_search LDAP_P(( /* deprecated */
1298 LDAP_CONST char *base,
1300 LDAP_CONST char *filter,
1305 ldap_search_s LDAP_P(( /* deprecated */
1307 LDAP_CONST char *base,
1309 LDAP_CONST char *filter,
1312 LDAPMessage **res ));
1315 ldap_search_st LDAP_P(( /* deprecated */
1317 LDAP_CONST char *base,
1319 LDAP_CONST char *filter,
1322 struct timeval *timeout,
1323 LDAPMessage **res ));
1331 ldap_ufn_search_c LDAP_P(( /* deprecated */
1333 LDAP_CONST char *ufn,
1337 int (*cancelproc)( void *cl ),
1338 void *cancelparm ));
1341 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1343 LDAP_CONST char *ufn,
1347 int (*cancelproc)( void *cl ),
1354 ldap_ufn_search_s LDAP_P(( /* deprecated */
1356 LDAP_CONST char *ufn,
1359 LDAPMessage **res ));
1361 LDAP_F( LDAPFiltDesc *)
1362 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1364 LDAP_CONST char *fname ));
1367 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1369 LDAP_CONST char *prefix ));
1372 ldap_ufn_timeout LDAP_P(( /* deprecated */
1380 ldap_unbind LDAP_P(( /* deprecated */
1384 ldap_unbind_s LDAP_P(( /* deprecated */
1388 ldap_unbind_ext LDAP_P((
1390 LDAPControl **serverctrls,
1391 LDAPControl **clientctrls));
1394 ldap_unbind_ext_s LDAP_P((
1396 LDAPControl **serverctrls,
1397 LDAPControl **clientctrls));
1403 LDAP_F( LDAPFiltDesc *)
1404 ldap_init_getfilter LDAP_P(( /* deprecated */
1405 LDAP_CONST char *fname ));
1407 LDAP_F( LDAPFiltDesc *)
1408 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1409 /* LDAP_CONST */ char *buf,
1410 ber_len_t buflen ));
1412 LDAP_F( LDAPFiltInfo *)
1413 ldap_getfirstfilter LDAP_P(( /* deprecated */
1415 /* LDAP_CONST */ char *tagpat,
1416 /* LDAP_CONST */ char *value ));
1418 LDAP_F( LDAPFiltInfo *)
1419 ldap_getnextfilter LDAP_P(( /* deprecated */
1420 LDAPFiltDesc *lfdp ));
1423 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1425 LDAP_CONST char *prefix,
1426 LDAP_CONST char *suffix ));
1429 ldap_build_filter LDAP_P(( /* deprecated */
1432 LDAP_CONST char *pattern,
1433 LDAP_CONST char *prefix,
1434 LDAP_CONST char *suffix,
1435 LDAP_CONST char *attr,
1436 LDAP_CONST char *value,
1445 ldap_memalloc LDAP_P((
1449 ldap_memrealloc LDAP_P((
1454 ldap_memcalloc LDAP_P((
1459 ldap_memfree LDAP_P((
1463 ldap_memvfree LDAP_P((
1467 ldap_strdup LDAP_P((
1468 LDAP_CONST char * ));
1471 ldap_getfilter_free LDAP_P((
1472 LDAPFiltDesc *lfdp ));
1475 ldap_mods_free LDAP_P((
1485 ldap_friendly_name LDAP_P(( /* deprecated */
1486 LDAP_CONST char *filename,
1487 /* LDAP_CONST */ char *uname,
1488 LDAPFriendlyMap **map ));
1491 ldap_free_friendlymap LDAP_P(( /* deprecated */
1492 LDAPFriendlyMap **map ));
1498 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1499 LDAP_CONST char *left,
1500 LDAP_CONST char *right ));
1502 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1503 LDAP_CONST void *left,
1504 LDAP_CONST void *right ));
1507 ldap_sort_entries LDAP_P(( LDAP *ld,
1508 LDAPMessage **chain,
1509 LDAP_CONST char *attr,
1510 LDAP_SORT_AD_CMP_PROC *cmp ));
1512 LDAP_F( int ) /* deprecated */
1513 ldap_sort_values LDAP_P((
1516 LDAP_SORT_AV_CMP_PROC *cmp ));
1518 LDAP_F( int ) /* deprecated */
1519 ldap_sort_strcasecmp LDAP_P((
1521 LDAP_CONST void *b ));
1527 * need _ext varients
1530 ldap_is_ldap_url LDAP_P((
1531 LDAP_CONST char *url ));
1534 ldap_is_ldaps_url LDAP_P((
1535 LDAP_CONST char *url ));
1538 ldap_is_ldapi_url LDAP_P((
1539 LDAP_CONST char *url ));
1542 ldap_url_parse LDAP_P((
1543 LDAP_CONST char *url,
1544 LDAPURLDesc **ludpp ));
1547 ldap_free_urldesc LDAP_P((
1548 LDAPURLDesc *ludp ));
1551 ldap_url_search LDAP_P((
1553 LDAP_CONST char *url,
1557 ldap_url_search_s LDAP_P((
1559 LDAP_CONST char *url,
1561 LDAPMessage **res ));
1564 ldap_url_search_st LDAP_P((
1566 LDAP_CONST char *url,
1568 struct timeval *timeout,
1569 LDAPMessage **res ));
1575 * structure for a sort-key
1577 typedef struct ldapsortkey {
1578 char * attributeType;
1579 char * orderingRule;
1584 ldap_create_sort_keylist LDAP_P((
1585 LDAPSortKey ***sortKeyList,
1589 ldap_free_sort_keylist LDAP_P((
1590 LDAPSortKey **sortkeylist ));
1593 ldap_create_sort_control LDAP_P((
1595 LDAPSortKey **keyList,
1597 LDAPControl **ctrlp ));
1600 ldap_parse_sort_control LDAP_P((
1602 LDAPControl **ctrlp,
1603 unsigned long *result,
1604 char **attribute ));
1612 * structure for virtul list.
1614 typedef struct ldapvlvinfo {
1616 unsigned long ldvlv_before_count;
1617 unsigned long ldvlv_after_count;
1618 unsigned long ldvlv_offset;
1619 unsigned long ldvlv_count;
1620 struct berval *ldvlv_attrvalue;
1621 struct berval *ldvlv_context;
1622 void *ldvlv_extradata;
1626 ldap_create_vlv_control LDAP_P((
1628 LDAPVLVInfo *ldvlistp,
1629 LDAPControl **ctrlp ));
1632 ldap_parse_vlv_control LDAP_P((
1634 LDAPControl **ctrls,
1635 unsigned long *target_posp,
1636 unsigned long *list_countp,
1637 struct berval **contextp,
1642 #endif /* _LDAP_H */