2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2005 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
32 /* include version and API feature defines */
33 #include <ldap_features.h>
37 #define LDAP_VERSION1 1
38 #define LDAP_VERSION2 2
39 #define LDAP_VERSION3 3
41 #define LDAP_VERSION_MIN LDAP_VERSION2
42 #define LDAP_VERSION LDAP_VERSION2
43 #define LDAP_VERSION_MAX LDAP_VERSION3
46 * We use 3000+n here because it is above 1823 (for RFC 1823),
47 * above 2000+rev of IETF LDAPEXT draft (now quite dated),
48 * yet below allocations for new RFCs (just in case there is
49 * someday an RFC produced).
51 #define LDAP_API_VERSION 3001
52 #define LDAP_VENDOR_NAME "OpenLDAP"
54 /* OpenLDAP API Features */
55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
58 ( defined( LDAP_THREAD_SAFE ) && \
59 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
60 /* -lldap may or may not be thread safe */
61 /* -lldap_r, if available, is always thread safe */
62 # define LDAP_API_FEATURE_THREAD_SAFE 1
64 #if defined( LDAP_THREAD_SAFE ) && \
65 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
66 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
67 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
71 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
72 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
74 #define LDAP_ROOT_DSE ""
75 #define LDAP_NO_ATTRS "1.1"
76 #define LDAP_ALL_USER_ATTRIBUTES "*"
77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
79 /* RFC 2251: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
80 #define LDAP_MAXINT (2147483647)
84 * 0x0000 - 0x0fff reserved for api options
85 * 0x1000 - 0x3fff reserved for api extended options
86 * 0x4000 - 0x7fff reserved for private and experimental options
89 #define LDAP_OPT_API_INFO 0x0000
90 #define LDAP_OPT_DESC 0x0001 /* historic */
91 #define LDAP_OPT_DEREF 0x0002
92 #define LDAP_OPT_SIZELIMIT 0x0003
93 #define LDAP_OPT_TIMELIMIT 0x0004
94 /* 0x05 - 0x07 not defined */
95 #define LDAP_OPT_REFERRALS 0x0008
96 #define LDAP_OPT_RESTART 0x0009
97 /* 0x0a - 0x10 not defined */
98 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
99 #define LDAP_OPT_SERVER_CONTROLS 0x0012
100 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
101 /* 0x14 not defined */
102 #define LDAP_OPT_API_FEATURE_INFO 0x0015
103 /* 0x16 - 0x2f not defined */
104 #define LDAP_OPT_HOST_NAME 0x0030
105 #define LDAP_OPT_RESULT_CODE 0x0031
106 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
107 #define LDAP_OPT_ERROR_STRING 0x0032
108 #define LDAP_OPT_MATCHED_DN 0x0033
109 /* 0x0034 - 0x3fff not defined */
112 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
114 /* private and experimental options */
115 /* OpenLDAP specific options */
116 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
117 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
118 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
119 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
120 #define LDAP_OPT_URI 0x5006
121 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
122 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
124 /* OpenLDAP TLS options */
125 #define LDAP_OPT_X_TLS 0x6000
126 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
127 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
128 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
129 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
130 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
131 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
132 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
133 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
134 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
135 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
136 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
137 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
138 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
140 #define LDAP_OPT_X_TLS_NEVER 0
141 #define LDAP_OPT_X_TLS_HARD 1
142 #define LDAP_OPT_X_TLS_DEMAND 2
143 #define LDAP_OPT_X_TLS_ALLOW 3
144 #define LDAP_OPT_X_TLS_TRY 4
146 #define LDAP_OPT_X_TLS_CRL_NONE 0
147 #define LDAP_OPT_X_TLS_CRL_PEER 1
148 #define LDAP_OPT_X_TLS_CRL_ALL 2
150 /* OpenLDAP SASL options */
151 #define LDAP_OPT_X_SASL_MECH 0x6100
152 #define LDAP_OPT_X_SASL_REALM 0x6101
153 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
154 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
155 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
156 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
157 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
158 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
159 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
160 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
162 /* Private API Extensions -- reserved for application use */
163 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
166 * ldap_get_option() and ldap_set_option() return values.
167 * As later versions may return other values indicating
168 * failure, current applications should only compare returned
169 * value against LDAP_OPT_SUCCESS.
171 #define LDAP_OPT_SUCCESS 0
172 #define LDAP_OPT_ERROR (-1)
174 /* option on/off values */
175 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
176 #define LDAP_OPT_OFF ((void *) 0)
178 typedef struct ldapapiinfo {
179 int ldapai_info_version; /* version of LDAPAPIInfo */
180 #define LDAP_API_INFO_VERSION (1)
181 int ldapai_api_version; /* revision of API supported */
182 int ldapai_protocol_version; /* highest LDAP version supported */
183 char **ldapai_extensions; /* names of API extensions */
184 char *ldapai_vendor_name; /* name of supplier */
185 int ldapai_vendor_version; /* supplier-specific version * 100 */
188 typedef struct ldap_apifeature_info {
189 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
190 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
191 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
192 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
193 } LDAPAPIFeatureInfo;
196 * LDAP Control structure
198 typedef struct ldapcontrol {
199 char * ldctl_oid; /* numericoid of control */
200 struct berval ldctl_value; /* encoded value of control */
201 char ldctl_iscritical; /* criticality */
205 /* standard track controls */
206 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
207 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
208 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
210 /* standard track - not implemented in slapd(8) */
211 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
212 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
214 /* but not yet formalized controls */
215 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
216 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
218 /* various works in progress */
219 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
220 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
221 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
222 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
225 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
226 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
227 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
228 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
229 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
232 /* LDAP VLV *//* not implemented in slapd(8) */
233 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
234 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
236 /* Password policy Controls *//* work in progress */
238 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
239 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
242 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
243 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
244 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
245 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
246 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
247 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
249 #define LDAP_SYNC_NONE 0x00
250 #define LDAP_SYNC_REFRESH_ONLY 0x01
251 #define LDAP_SYNC_RESERVED 0x02
252 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
254 #define LDAP_SYNC_REFRESH_PRESENTS 0
255 #define LDAP_SYNC_REFRESH_DELETES 1
257 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
258 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
259 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
260 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
262 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
263 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
264 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
265 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
267 #define LDAP_SYNC_PRESENT 0
268 #define LDAP_SYNC_ADD 1
269 #define LDAP_SYNC_MODIFY 2
270 #define LDAP_SYNC_DELETE 3
272 /* MS ActiveDirectory controls (for compatibility) */
273 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
274 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
275 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
276 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
277 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
278 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
279 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
281 /* LDAP Unsolicited Notifications */
282 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
283 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
285 /* LDAP Extended Operations */
286 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
288 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
289 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
290 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
291 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
292 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
294 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
295 #define LDAP_EXOP_X_CANCEL "1.3.6.1.1.8"
297 /* LDAP Grouping of Related Operations *//* a work in progress */
299 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
300 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
301 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
302 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
303 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
304 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
305 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
308 /* LDAP Grouping Types *//* a work in progress */
310 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
314 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
315 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
316 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
317 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
318 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
319 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
320 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
323 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
324 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
325 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
329 * specific LDAP instantiations of BER types we know about
332 /* Overview of LBER tag construction
339 * 1 0 = CONTEXT-SPECIFIC
346 * | 5 ... 1 | TAG-NUMBER
350 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
351 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
353 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
354 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
356 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
357 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
359 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
361 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
362 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
363 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
364 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
366 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
367 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
369 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
371 /* LDAP Request Messages */
372 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
373 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
374 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
375 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
376 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
377 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
378 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
379 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
380 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
381 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
382 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
383 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
385 /* LDAP Response Messages */
386 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
387 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
388 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
389 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
390 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
391 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
392 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
393 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
394 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
395 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
396 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
397 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
398 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
400 #define LDAP_RES_ANY (-1)
401 #define LDAP_RES_UNSOLICITED (0)
405 #define LDAP_SASL_SIMPLE ((char*)0)
406 #define LDAP_SASL_NULL ("")
409 /* authentication methods available */
410 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
411 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
412 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
413 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
414 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
415 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
419 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
420 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
421 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
422 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
423 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
424 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
425 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
426 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
427 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
428 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
430 /* extended filter component types */
431 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
432 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
433 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
434 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
436 /* substring filter component types */
437 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
438 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
439 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
442 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
443 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
444 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
445 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
446 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
447 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
448 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
450 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
451 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
454 /* substring filter component types */
455 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
456 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
457 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
462 #define LDAP_SUCCESS 0x00
464 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
466 #define LDAP_OPERATIONS_ERROR 0x01
467 #define LDAP_PROTOCOL_ERROR 0x02
468 #define LDAP_TIMELIMIT_EXCEEDED 0x03
469 #define LDAP_SIZELIMIT_EXCEEDED 0x04
470 #define LDAP_COMPARE_FALSE 0x05
471 #define LDAP_COMPARE_TRUE 0x06
472 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
473 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
474 #define LDAP_STRONG_AUTH_REQUIRED 0x08
475 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
476 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
478 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
479 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
480 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
481 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
482 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
484 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
486 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
487 #define LDAP_UNDEFINED_TYPE 0x11
488 #define LDAP_INAPPROPRIATE_MATCHING 0x12
489 #define LDAP_CONSTRAINT_VIOLATION 0x13
490 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
491 #define LDAP_INVALID_SYNTAX 0x15
493 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
495 #define LDAP_NO_SUCH_OBJECT 0x20
496 #define LDAP_ALIAS_PROBLEM 0x21
497 #define LDAP_INVALID_DN_SYNTAX 0x22
498 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
499 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
501 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
503 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
504 #define LDAP_INAPPROPRIATE_AUTH 0x30
505 #define LDAP_INVALID_CREDENTIALS 0x31
506 #define LDAP_INSUFFICIENT_ACCESS 0x32
508 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
510 #define LDAP_BUSY 0x33
511 #define LDAP_UNAVAILABLE 0x34
512 #define LDAP_UNWILLING_TO_PERFORM 0x35
513 #define LDAP_LOOP_DETECT 0x36
515 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
517 #define LDAP_NAMING_VIOLATION 0x40
518 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
519 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
520 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
521 #define LDAP_ALREADY_EXISTS 0x44
522 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
523 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
524 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
526 #define LDAP_OTHER 0x50
528 /* LCUP operation codes (113-117) - not implemented */
529 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
530 #define LDAP_CUP_SECURITY_VIOLATION 0x72
531 #define LDAP_CUP_INVALID_DATA 0x73
532 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
533 #define LDAP_CUP_RELOAD_REQUIRED 0x75
535 /* Cancel operation codes (118-121) */
536 #define LDAP_CANCELLED 0x76
537 #define LDAP_NO_SUCH_OPERATION 0x77
538 #define LDAP_TOO_LATE 0x78
539 #define LDAP_CANNOT_CANCEL 0x79
542 /* Experimental result codes */
543 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
544 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
546 /* for the LDAP Sync operation */
547 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
549 /* for the LDAP No-Op control */
550 #define LDAP_NO_OPERATION 0x410e
552 /* for the Assertion control */
553 #define LDAP_ASSERTION_FAILED 0x410f
557 * Based on draft-ietf-ldap-c-api-xx
558 * but with new negative code values
560 #define LDAP_API_ERROR(n) ((n)<0)
561 #define LDAP_API_RESULT(n) ((n)<=0)
563 #define LDAP_SERVER_DOWN (-1)
564 #define LDAP_LOCAL_ERROR (-2)
565 #define LDAP_ENCODING_ERROR (-3)
566 #define LDAP_DECODING_ERROR (-4)
567 #define LDAP_TIMEOUT (-5)
568 #define LDAP_AUTH_UNKNOWN (-6)
569 #define LDAP_FILTER_ERROR (-7)
570 #define LDAP_USER_CANCELLED (-8)
571 #define LDAP_PARAM_ERROR (-9)
572 #define LDAP_NO_MEMORY (-10)
573 #define LDAP_CONNECT_ERROR (-11)
574 #define LDAP_NOT_SUPPORTED (-12)
575 #define LDAP_CONTROL_NOT_FOUND (-13)
576 #define LDAP_NO_RESULTS_RETURNED (-14)
577 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
578 #define LDAP_CLIENT_LOOP (-16)
579 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
583 * This structure represents both ldap messages and ldap responses.
584 * These are really the same, except in the case of search responses,
585 * where a response has multiple messages.
588 typedef struct ldapmsg LDAPMessage;
590 /* for modifications */
591 typedef struct ldapmod {
594 #define LDAP_MOD_OP (0x0007)
595 #define LDAP_MOD_ADD (0x0000)
596 #define LDAP_MOD_DELETE (0x0001)
597 #define LDAP_MOD_REPLACE (0x0002)
598 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
599 #define LDAP_MOD_BVALUES (0x0080)
600 /* IMPORTANT: do not use code 0x1000 (or above),
601 * it is used internally by the backends!
602 * (see ldap/servers/slapd/slap.h)
608 struct berval **modv_bvals;
610 #define mod_values mod_vals.modv_strvals
611 #define mod_bvalues mod_vals.modv_bvals
615 * structure representing an ldap session which can
616 * encompass connections to multiple servers (in the
617 * face of referrals).
619 typedef struct ldap LDAP;
621 #define LDAP_DEREF_NEVER 0x00
622 #define LDAP_DEREF_SEARCHING 0x01
623 #define LDAP_DEREF_FINDING 0x02
624 #define LDAP_DEREF_ALWAYS 0x03
626 #define LDAP_NO_LIMIT 0
628 /* how many messages to retrieve results for */
629 #define LDAP_MSG_ONE 0x00
630 #define LDAP_MSG_ALL 0x01
631 #define LDAP_MSG_RECEIVED 0x02
634 * types for ldap URL handling
636 typedef struct ldap_url_desc {
637 struct ldap_url_desc *lud_next;
649 #define LDAP_URL_SUCCESS 0x00 /* Success */
650 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
651 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
653 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
654 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
655 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
656 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
657 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
658 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
659 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
660 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
663 * The API draft spec says we should declare (or cause to be declared)
664 * 'struct timeval'. We don't. See IETF LDAPext discussions.
672 ldap_get_option LDAP_P((
678 ldap_set_option LDAP_P((
681 LDAP_CONST void *invalue));
683 /* V3 REBIND Function Callback Prototype */
684 typedef int (LDAP_REBIND_PROC) LDAP_P((
685 LDAP *ld, LDAP_CONST char *url,
686 ber_tag_t request, ber_int_t msgid,
690 ldap_set_rebind_proc LDAP_P((
692 LDAP_REBIND_PROC *rebind_proc,
699 ldap_create_control LDAP_P((
700 LDAP_CONST char *requestOID,
703 LDAPControl **ctrlp ));
705 LDAP_F( LDAPControl * )
706 ldap_find_control LDAP_P((
707 LDAP_CONST char *oid,
708 LDAPControl **ctrls ));
711 ldap_control_free LDAP_P((
712 LDAPControl *ctrl ));
715 ldap_controls_free LDAP_P((
716 LDAPControl **ctrls ));
722 ldap_domain2dn LDAP_P((
723 LDAP_CONST char* domain,
727 ldap_dn2domain LDAP_P((
732 ldap_domain2hostlist LDAP_P((
733 LDAP_CONST char *domain,
740 ldap_extended_operation LDAP_P((
742 LDAP_CONST char *reqoid,
743 struct berval *reqdata,
744 LDAPControl **serverctrls,
745 LDAPControl **clientctrls,
749 ldap_extended_operation_s LDAP_P((
751 LDAP_CONST char *reqoid,
752 struct berval *reqdata,
753 LDAPControl **serverctrls,
754 LDAPControl **clientctrls,
756 struct berval **retdatap ));
759 ldap_parse_extended_result LDAP_P((
763 struct berval **retdatap,
767 ldap_parse_intermediate LDAP_P((
771 struct berval **retdatap,
772 LDAPControl ***serverctrls,
778 #ifdef LDAP_EXOP_GROUPING_CREATE
781 ldap_grouping_create LDAP_P((
783 LDAP_CONST char *grpoid,
784 struct berval *grpdata,
785 LDAPControl **serverctrls,
786 LDAPControl **clientctrls,
790 ldap_grouping_create_s LDAP_P((
792 LDAP_CONST char *grpoid,
793 struct berval *grpdata,
794 LDAPControl **serverctrls,
795 LDAPControl **clientctrls,
796 struct berval **retgrpcookiep,
797 struct berval **retgrpdatap ));
800 ldap_parse_grouping_create_result LDAP_P((
803 struct berval **retgrpcookiep,
804 struct berval **retgrpdatap,
805 LDAPControl ***serverctrls,
809 ldap_grouping_end LDAP_P((
811 LDAP_CONST char *grpoid,
812 struct berval *grpdata,
813 LDAPControl **serverctrls,
814 LDAPControl **clientctrls,
818 ldap_grouping_end_s LDAP_P((
820 LDAP_CONST char *grpoid,
821 struct berval *grpdata,
822 LDAPControl **serverctrls,
823 LDAPControl **clientctrls,
824 struct berval **retgrpdatap ));
827 ldap_parse_grouping_end_result LDAP_P((
830 struct berval **retgrpdatap,
831 LDAPControl ***serverctrls,
835 ldap_grouping_action_operation LDAP_P((
837 LDAP_CONST char *grpoid,
838 struct berval *grpdata,
839 LDAPControl **serverctrls,
840 LDAPControl **clientctrls,
844 ldap_grouping_action_operation_s LDAP_P((
846 LDAP_CONST char *grpoid,
847 struct berval *grpdata,
848 LDAPControl **serverctrls,
849 LDAPControl **clientctrls,
850 struct berval **retgrpcookiep,
851 struct berval **retgrpdatap ));
854 ldap_parse_grouping_action_result LDAP_P((
857 struct berval **retgrpcookiep,
858 struct berval **retgrpdatap,
859 LDAPControl ***serverctrls,
863 ldap_parse_grouping_end_notice LDAP_P((
866 struct berval **retdatap,
867 struct berval **retgrpcookiep,
868 struct berval **retgrpdatap,
872 ldap_parse_grouping_info_notice LDAP_P((
875 struct berval **retdatap,
876 struct berval **retgrpcookiep,
877 struct berval **retgrpdatap,
885 ldap_abandon_ext LDAP_P((
888 LDAPControl **serverctrls,
889 LDAPControl **clientctrls ));
893 ldap_abandon LDAP_P(( /* deprecated */
903 ldap_add_ext LDAP_P((
907 LDAPControl **serverctrls,
908 LDAPControl **clientctrls,
912 ldap_add_ext_s LDAP_P((
916 LDAPControl **serverctrls,
917 LDAPControl **clientctrls ));
921 ldap_add LDAP_P(( /* deprecated */
927 ldap_add_s LDAP_P(( /* deprecated */
938 ldap_sasl_bind LDAP_P((
941 LDAP_CONST char *mechanism,
943 LDAPControl **serverctrls,
944 LDAPControl **clientctrls,
947 /* Interaction flags (should be passed about in a control)
948 * Automatic (default): use defaults, prompt otherwise
949 * Interactive: prompt always
950 * Quiet: never prompt
952 #define LDAP_SASL_AUTOMATIC 0U
953 #define LDAP_SASL_INTERACTIVE 1U
954 #define LDAP_SASL_QUIET 2U
957 * V3 SASL Interaction Function Callback Prototype
958 * when using Cyrus SASL, interact is pointer to sasl_interact_t
959 * should likely passed in a control (and provided controls)
961 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
962 LDAP *ld, unsigned flags, void* defaults, void *interact ));
965 ldap_sasl_interactive_bind_s LDAP_P((
967 LDAP_CONST char *dn, /* usually NULL */
968 LDAP_CONST char *saslMechanism,
969 LDAPControl **serverControls,
970 LDAPControl **clientControls,
972 /* should be client controls */
974 LDAP_SASL_INTERACT_PROC *proc,
978 ldap_sasl_bind_s LDAP_P((
981 LDAP_CONST char *mechanism,
983 LDAPControl **serverctrls,
984 LDAPControl **clientctrls,
985 struct berval **servercredp ));
988 ldap_parse_sasl_bind_result LDAP_P((
991 struct berval **servercredp,
1000 ldap_bind LDAP_P(( /* deprecated */
1002 LDAP_CONST char *who,
1003 LDAP_CONST char *passwd,
1007 ldap_bind_s LDAP_P(( /* deprecated */
1009 LDAP_CONST char *who,
1010 LDAP_CONST char *cred,
1017 ldap_simple_bind LDAP_P(( /* deprecated */
1019 LDAP_CONST char *who,
1020 LDAP_CONST char *passwd ));
1023 ldap_simple_bind_s LDAP_P(( /* deprecated */
1025 LDAP_CONST char *who,
1026 LDAP_CONST char *passwd ));
1034 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1036 LDAP_CONST char *who ));
1039 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1041 LDAP_CONST char *who ));
1044 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1046 LDAP_CONST char *who ));
1049 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1051 LDAP_CONST char *who ));
1054 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1056 LDAP_CONST char *who ));
1064 ldap_compare_ext LDAP_P((
1066 LDAP_CONST char *dn,
1067 LDAP_CONST char *attr,
1068 struct berval *bvalue,
1069 LDAPControl **serverctrls,
1070 LDAPControl **clientctrls,
1074 ldap_compare_ext_s LDAP_P((
1076 LDAP_CONST char *dn,
1077 LDAP_CONST char *attr,
1078 struct berval *bvalue,
1079 LDAPControl **serverctrls,
1080 LDAPControl **clientctrls ));
1084 ldap_compare LDAP_P(( /* deprecated */
1086 LDAP_CONST char *dn,
1087 LDAP_CONST char *attr,
1088 LDAP_CONST char *value ));
1091 ldap_compare_s LDAP_P(( /* deprecated */
1093 LDAP_CONST char *dn,
1094 LDAP_CONST char *attr,
1095 LDAP_CONST char *value ));
1103 ldap_delete_ext LDAP_P((
1105 LDAP_CONST char *dn,
1106 LDAPControl **serverctrls,
1107 LDAPControl **clientctrls,
1111 ldap_delete_ext_s LDAP_P((
1113 LDAP_CONST char *dn,
1114 LDAPControl **serverctrls,
1115 LDAPControl **clientctrls ));
1119 ldap_delete LDAP_P(( /* deprecated */
1121 LDAP_CONST char *dn ));
1124 ldap_delete_s LDAP_P(( /* deprecated */
1126 LDAP_CONST char *dn ));
1134 ldap_parse_result LDAP_P((
1141 LDAPControl ***serverctrls,
1145 ldap_err2string LDAP_P((
1150 ldap_result2error LDAP_P(( /* deprecated */
1156 ldap_perror LDAP_P(( /* deprecated */
1158 LDAP_CONST char *s ));
1166 ldap_modify_ext LDAP_P((
1168 LDAP_CONST char *dn,
1170 LDAPControl **serverctrls,
1171 LDAPControl **clientctrls,
1175 ldap_modify_ext_s LDAP_P((
1177 LDAP_CONST char *dn,
1179 LDAPControl **serverctrls,
1180 LDAPControl **clientctrls ));
1184 ldap_modify LDAP_P(( /* deprecated */
1186 LDAP_CONST char *dn,
1190 ldap_modify_s LDAP_P(( /* deprecated */
1192 LDAP_CONST char *dn,
1201 ldap_rename LDAP_P((
1203 LDAP_CONST char *dn,
1204 LDAP_CONST char *newrdn,
1205 LDAP_CONST char *newSuperior,
1207 LDAPControl **sctrls,
1208 LDAPControl **cctrls,
1212 ldap_rename_s LDAP_P((
1214 LDAP_CONST char *dn,
1215 LDAP_CONST char *newrdn,
1216 LDAP_CONST char *newSuperior,
1218 LDAPControl **sctrls,
1219 LDAPControl **cctrls ));
1223 ldap_rename2 LDAP_P(( /* deprecated */
1225 LDAP_CONST char *dn,
1226 LDAP_CONST char *newrdn,
1227 LDAP_CONST char *newSuperior,
1228 int deleteoldrdn ));
1231 ldap_rename2_s LDAP_P(( /* deprecated */
1233 LDAP_CONST char *dn,
1234 LDAP_CONST char *newrdn,
1235 LDAP_CONST char *newSuperior,
1236 int deleteoldrdn ));
1239 ldap_modrdn LDAP_P(( /* deprecated */
1241 LDAP_CONST char *dn,
1242 LDAP_CONST char *newrdn ));
1245 ldap_modrdn_s LDAP_P(( /* deprecated */
1247 LDAP_CONST char *dn,
1248 LDAP_CONST char *newrdn ));
1251 ldap_modrdn2 LDAP_P(( /* deprecated */
1253 LDAP_CONST char *dn,
1254 LDAP_CONST char *newrdn,
1255 int deleteoldrdn ));
1258 ldap_modrdn2_s LDAP_P(( /* deprecated */
1260 LDAP_CONST char *dn,
1261 LDAP_CONST char *newrdn,
1271 ldap_init LDAP_P(( /* deprecated */
1272 LDAP_CONST char *host,
1276 ldap_open LDAP_P(( /* deprecated */
1277 LDAP_CONST char *host,
1282 ldap_create LDAP_P((
1286 ldap_initialize LDAP_P((
1288 LDAP_CONST char *url ));
1291 ldap_start_tls_s LDAP_P((
1293 LDAPControl **serverctrls,
1294 LDAPControl **clientctrls ));
1299 LDAP_F( LDAPMessage * )
1300 ldap_first_message LDAP_P((
1302 LDAPMessage *chain ));
1304 LDAP_F( LDAPMessage * )
1305 ldap_next_message LDAP_P((
1307 LDAPMessage *msg ));
1310 ldap_count_messages LDAP_P((
1312 LDAPMessage *chain ));
1317 LDAP_F( LDAPMessage * )
1318 ldap_first_reference LDAP_P((
1320 LDAPMessage *chain ));
1322 LDAP_F( LDAPMessage * )
1323 ldap_next_reference LDAP_P((
1325 LDAPMessage *ref ));
1328 ldap_count_references LDAP_P((
1330 LDAPMessage *chain ));
1333 ldap_parse_reference LDAP_P((
1337 LDAPControl ***serverctrls,
1344 LDAP_F( LDAPMessage * )
1345 ldap_first_entry LDAP_P((
1347 LDAPMessage *chain ));
1349 LDAP_F( LDAPMessage * )
1350 ldap_next_entry LDAP_P((
1352 LDAPMessage *entry ));
1355 ldap_count_entries LDAP_P((
1357 LDAPMessage *chain ));
1360 ldap_get_entry_controls LDAP_P((
1363 LDAPControl ***serverctrls));
1369 LDAP_F( LDAPMessage * )
1370 ldap_delete_result_entry LDAP_P((
1375 ldap_add_result_entry LDAP_P((
1384 ldap_get_dn LDAP_P((
1386 LDAPMessage *entry ));
1388 typedef struct ldap_ava {
1389 struct berval la_attr;
1390 struct berval la_value;
1392 #define LDAP_AVA_NULL 0x0000U
1393 #define LDAP_AVA_STRING 0x0001U
1394 #define LDAP_AVA_BINARY 0x0002U
1395 #define LDAP_AVA_NONPRINTABLE 0x0004U
1396 #define LDAP_AVA_FREE_ATTR 0x0010U
1397 #define LDAP_AVA_FREE_VALUE 0x0020U
1402 typedef LDAPAVA** LDAPRDN;
1403 typedef LDAPRDN* LDAPDN;
1406 #define LDAP_DN_FORMAT_LDAP 0x0000U
1407 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1408 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1409 #define LDAP_DN_FORMAT_DCE 0x0030U
1410 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1411 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1412 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1413 #define LDAP_DN_FORMAT_MASK 0x00F0U
1416 #define LDAP_DN_PRETTY 0x0100U
1417 #define LDAP_DN_SKIP 0x0200U
1418 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1419 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1420 #define LDAP_DN_PEDANTIC 0xF000U
1422 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1423 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1432 ldap_str2dn LDAP_P((
1433 LDAP_CONST char *str,
1444 ldap_dn2str LDAP_P((
1450 ldap_bv2rdn LDAP_P((
1457 ldap_str2rdn LDAP_P((
1458 LDAP_CONST char *str,
1464 ldap_rdn2bv LDAP_P((
1470 ldap_rdn2str LDAP_P((
1476 ldap_dn_normalize LDAP_P((
1477 LDAP_CONST char *in, unsigned iflags,
1478 char **out, unsigned oflags ));
1481 ldap_dn2ufn LDAP_P(( /* deprecated */
1482 LDAP_CONST char *dn ));
1485 ldap_explode_dn LDAP_P(( /* deprecated */
1486 LDAP_CONST char *dn,
1490 ldap_explode_rdn LDAP_P(( /* deprecated */
1491 LDAP_CONST char *rdn,
1494 typedef int LDAPDN_rewrite_func
1495 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1498 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1499 LDAPDN_rewrite_func *func, unsigned flags ));
1502 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1505 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1508 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1511 ldap_get_dn_ber LDAP_P((
1512 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1515 ldap_get_attribute_ber LDAP_P((
1516 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1517 struct berval **vals ));
1523 ldap_first_attribute LDAP_P((
1526 BerElement **ber ));
1529 ldap_next_attribute LDAP_P((
1538 LDAP_F( struct berval ** )
1539 ldap_get_values_len LDAP_P((
1542 LDAP_CONST char *target ));
1545 ldap_count_values_len LDAP_P((
1546 struct berval **vals ));
1549 ldap_value_free_len LDAP_P((
1550 struct berval **vals ));
1554 ldap_get_values LDAP_P(( /* deprecated */
1557 LDAP_CONST char *target ));
1560 ldap_count_values LDAP_P(( /* deprecated */
1564 ldap_value_free LDAP_P(( /* deprecated */
1572 ldap_result LDAP_P((
1576 struct timeval *timeout,
1577 LDAPMessage **result ));
1580 ldap_msgtype LDAP_P((
1588 ldap_msgfree LDAP_P((
1592 ldap_msgdelete LDAP_P((
1601 ldap_search_ext LDAP_P((
1603 LDAP_CONST char *base,
1605 LDAP_CONST char *filter,
1608 LDAPControl **serverctrls,
1609 LDAPControl **clientctrls,
1610 struct timeval *timeout,
1615 ldap_search_ext_s LDAP_P((
1617 LDAP_CONST char *base,
1619 LDAP_CONST char *filter,
1622 LDAPControl **serverctrls,
1623 LDAPControl **clientctrls,
1624 struct timeval *timeout,
1626 LDAPMessage **res ));
1630 ldap_search LDAP_P(( /* deprecated */
1632 LDAP_CONST char *base,
1634 LDAP_CONST char *filter,
1639 ldap_search_s LDAP_P(( /* deprecated */
1641 LDAP_CONST char *base,
1643 LDAP_CONST char *filter,
1646 LDAPMessage **res ));
1649 ldap_search_st LDAP_P(( /* deprecated */
1651 LDAP_CONST char *base,
1653 LDAP_CONST char *filter,
1656 struct timeval *timeout,
1657 LDAPMessage **res ));
1664 ldap_unbind_ext LDAP_P((
1666 LDAPControl **serverctrls,
1667 LDAPControl **clientctrls));
1670 ldap_unbind_ext_s LDAP_P((
1672 LDAPControl **serverctrls,
1673 LDAPControl **clientctrls));
1677 ldap_unbind LDAP_P(( /* deprecated */
1681 ldap_unbind_s LDAP_P(( /* deprecated */
1689 ldap_put_vrFilter LDAP_P((
1698 ldap_memalloc LDAP_P((
1702 ldap_memrealloc LDAP_P((
1707 ldap_memcalloc LDAP_P((
1712 ldap_memfree LDAP_P((
1716 ldap_memvfree LDAP_P((
1720 ldap_strdup LDAP_P((
1721 LDAP_CONST char * ));
1724 ldap_mods_free LDAP_P((
1731 * in sort.c (deprecated)
1733 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1734 LDAP_CONST char *left,
1735 LDAP_CONST char *right ));
1737 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1738 LDAP_CONST void *left,
1739 LDAP_CONST void *right ));
1741 LDAP_F( int ) /* deprecated */
1742 ldap_sort_entries LDAP_P(( LDAP *ld,
1743 LDAPMessage **chain,
1744 LDAP_CONST char *attr,
1745 LDAP_SORT_AD_CMP_PROC *cmp ));
1747 LDAP_F( int ) /* deprecated */
1748 ldap_sort_values LDAP_P((
1751 LDAP_SORT_AV_CMP_PROC *cmp ));
1753 LDAP_F( int ) /* deprecated */
1754 ldap_sort_strcasecmp LDAP_P((
1756 LDAP_CONST void *b ));
1763 ldap_is_ldap_url LDAP_P((
1764 LDAP_CONST char *url ));
1767 ldap_is_ldaps_url LDAP_P((
1768 LDAP_CONST char *url ));
1771 ldap_is_ldapi_url LDAP_P((
1772 LDAP_CONST char *url ));
1775 ldap_url_parse LDAP_P((
1776 LDAP_CONST char *url,
1777 LDAPURLDesc **ludpp ));
1780 ldap_url_desc2str LDAP_P((
1781 LDAPURLDesc *ludp ));
1784 ldap_free_urldesc LDAP_P((
1785 LDAPURLDesc *ludp ));
1789 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1792 #define LDAP_API_FEATURE_CANCEL 1000
1795 ldap_cancel LDAP_P(( LDAP *ld,
1797 LDAPControl **sctrls,
1798 LDAPControl **cctrls,
1802 ldap_cancel_s LDAP_P((
1805 LDAPControl **sctrl,
1806 LDAPControl **cctrl ));
1809 * LDAP Server Side Sort
1812 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1814 /* structure for a sort-key */
1815 typedef struct ldapsortkey {
1816 char * attributeType;
1817 char * orderingRule;
1822 ldap_create_sort_keylist LDAP_P((
1823 LDAPSortKey ***sortKeyList,
1827 ldap_free_sort_keylist LDAP_P((
1828 LDAPSortKey **sortkeylist ));
1831 ldap_create_sort_control LDAP_P((
1833 LDAPSortKey **keyList,
1835 LDAPControl **ctrlp ));
1838 ldap_parse_sort_control LDAP_P((
1840 LDAPControl **ctrlp,
1841 unsigned long *result,
1842 char **attribute ));
1846 * LDAP Virtual List View
1849 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1851 /* structure for virtual list */
1852 typedef struct ldapvlvinfo {
1854 unsigned long ldvlv_before_count;
1855 unsigned long ldvlv_after_count;
1856 unsigned long ldvlv_offset;
1857 unsigned long ldvlv_count;
1858 struct berval * ldvlv_attrvalue;
1859 struct berval * ldvlv_context;
1860 void * ldvlv_extradata;
1864 ldap_create_vlv_control LDAP_P((
1866 LDAPVLVInfo *ldvlistp,
1867 LDAPControl **ctrlp ));
1870 ldap_parse_vlv_control LDAP_P((
1872 LDAPControl **ctrls,
1873 unsigned long *target_posp,
1874 unsigned long *list_countp,
1875 struct berval **contextp,
1882 #ifdef LDAP_GROUPING_TRANSACTION
1884 ldap_parse_txn_create LDAP_P((
1887 struct berval **cookie ));
1890 ldap_txn_create LDAP_P((
1892 LDAPControl **sctrls,
1893 LDAPControl **cctrls,
1897 ldap_txn_create_s LDAP_P((
1899 struct berval **cookie,
1900 LDAPControl **sctrls,
1901 LDAPControl **cctrls ));
1904 ldap_txn_end LDAP_P((
1906 struct berval *cookie,
1908 LDAPControl **sctrls,
1909 LDAPControl **cctrls,
1913 ldap_txn_end_s LDAP_P((
1915 struct berval *cookie,
1917 LDAPControl **sctrls,
1918 LDAPControl **cctrls ));
1925 #define LDAP_API_FEATURE_WHOAMI 1000
1928 ldap_parse_whoami LDAP_P((
1931 struct berval **authzid ));
1934 ldap_whoami LDAP_P(( LDAP *ld,
1935 LDAPControl **sctrls,
1936 LDAPControl **cctrls,
1940 ldap_whoami_s LDAP_P((
1942 struct berval **authzid,
1943 LDAPControl **sctrls,
1944 LDAPControl **cctrls ));
1947 * LDAP Password Modify
1950 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1953 ldap_parse_passwd LDAP_P((
1956 struct berval *newpasswd ));
1959 ldap_passwd LDAP_P(( LDAP *ld,
1960 struct berval *user,
1961 struct berval *oldpw,
1962 struct berval *newpw,
1963 LDAPControl **sctrls,
1964 LDAPControl **cctrls,
1968 ldap_passwd_s LDAP_P((
1970 struct berval *user,
1971 struct berval *oldpw,
1972 struct berval *newpw,
1973 struct berval *newpasswd,
1974 LDAPControl **sctrls,
1975 LDAPControl **cctrls ));
1977 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
1979 * LDAP Password Policy controls
1982 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
1984 typedef enum passpolicyerror_enum {
1985 PP_passwordExpired = 0,
1986 PP_accountLocked = 1,
1987 PP_changeAfterReset = 2,
1988 PP_passwordModNotAllowed = 3,
1989 PP_mustSupplyOldPassword = 4,
1990 PP_insufficientPasswordQuality = 5,
1991 PP_passwordTooShort = 6,
1992 PP_passwordTooYoung = 7,
1993 PP_passwordInHistory = 8,
1995 } LDAPPasswordPolicyError;
1998 ldap_create_passwordpolicy_control LDAP_P((
2000 LDAPControl **ctrlp ));
2003 ldap_parse_passwordpolicy_control LDAP_P((
2008 LDAPPasswordPolicyError *errorp ));
2010 LDAP_F( const char * )
2011 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2012 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2015 #endif /* _LDAP_H */