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
139 #define LDAP_OPT_X_TLS_DHFILE 0x600e
141 #define LDAP_OPT_X_TLS_NEVER 0
142 #define LDAP_OPT_X_TLS_HARD 1
143 #define LDAP_OPT_X_TLS_DEMAND 2
144 #define LDAP_OPT_X_TLS_ALLOW 3
145 #define LDAP_OPT_X_TLS_TRY 4
147 #define LDAP_OPT_X_TLS_CRL_NONE 0
148 #define LDAP_OPT_X_TLS_CRL_PEER 1
149 #define LDAP_OPT_X_TLS_CRL_ALL 2
151 /* OpenLDAP SASL options */
152 #define LDAP_OPT_X_SASL_MECH 0x6100
153 #define LDAP_OPT_X_SASL_REALM 0x6101
154 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
155 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
156 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
157 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
158 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
159 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
160 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
161 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
163 /* Private API Extensions -- reserved for application use */
164 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
167 * ldap_get_option() and ldap_set_option() return values.
168 * As later versions may return other values indicating
169 * failure, current applications should only compare returned
170 * value against LDAP_OPT_SUCCESS.
172 #define LDAP_OPT_SUCCESS 0
173 #define LDAP_OPT_ERROR (-1)
175 /* option on/off values */
176 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
177 #define LDAP_OPT_OFF ((void *) 0)
179 typedef struct ldapapiinfo {
180 int ldapai_info_version; /* version of LDAPAPIInfo */
181 #define LDAP_API_INFO_VERSION (1)
182 int ldapai_api_version; /* revision of API supported */
183 int ldapai_protocol_version; /* highest LDAP version supported */
184 char **ldapai_extensions; /* names of API extensions */
185 char *ldapai_vendor_name; /* name of supplier */
186 int ldapai_vendor_version; /* supplier-specific version * 100 */
189 typedef struct ldap_apifeature_info {
190 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
191 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
192 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
193 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
194 } LDAPAPIFeatureInfo;
197 * LDAP Control structure
199 typedef struct ldapcontrol {
200 char * ldctl_oid; /* numericoid of control */
201 struct berval ldctl_value; /* encoded value of control */
202 char ldctl_iscritical; /* criticality */
206 /* standard track controls */
207 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
208 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC TBD */
209 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
211 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"/* RFC 3876 */
212 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC TBD */
213 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC TBD */
214 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC TBD */
216 /* standard track - not implemented in slapd(8) */
217 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
218 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
220 /* non-standard track controls */
221 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
223 /* Password policy Controls *//* work in progress */
224 /* ITS#3458: released; disabled by default */
225 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
226 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
228 /* various works in progress */
229 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
230 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
231 #define LDAP_CONTROL_MANAGEDIT "1.3.6.1.4.1.4203.666.5.12"
232 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
233 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
234 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
236 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
237 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
238 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
239 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
240 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
241 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
243 #define LDAP_SYNC_NONE 0x00
244 #define LDAP_SYNC_REFRESH_ONLY 0x01
245 #define LDAP_SYNC_RESERVED 0x02
246 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
248 #define LDAP_SYNC_REFRESH_PRESENTS 0
249 #define LDAP_SYNC_REFRESH_DELETES 1
251 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
252 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
253 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
254 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
256 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
257 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
258 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
259 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
261 #define LDAP_SYNC_PRESENT 0
262 #define LDAP_SYNC_ADD 1
263 #define LDAP_SYNC_MODIFY 2
264 #define LDAP_SYNC_DELETE 3
266 /* LDAP Chaining Behavior Control *//* work in progress */
267 /* <draft-sermersheim-ldap-chaining>;
268 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
270 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
272 #define LDAP_CHAINING_PREFERRED 0
273 #define LDAP_CHAINING_REQUIRED 1
274 #define LDAP_REFERRALS_PREFERRED 2
275 #define LDAP_REFERRALS_REQUIRED 3
278 /* MS Active Directory controls (for compatibility) */
279 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
280 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
281 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
282 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
283 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
284 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
286 /* MS Active Directory controls - not implemented in slapd(8) */
287 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
288 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
290 /* various expired works */
291 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
292 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
293 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
294 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
295 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
297 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
298 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
299 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
300 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_ADD 0x1
301 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_DELETE 0x2
302 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_MODIFY 0x4
303 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_RENAME 0x8
305 /* LDAP VLV *//* not implemented in slapd(8) */
306 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
307 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
310 /* LDAP Unsolicited Notifications */
311 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
312 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
314 /* LDAP Extended Operations */
315 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
317 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
318 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
319 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
320 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
321 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
323 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
324 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
326 /* various works in progress */
327 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
328 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
330 #define LDAP_EXOP_X_TURN "1.3.6.1.4.1.4203.666.6.4"
332 /* LDAP Grouping of Related Operations *//* a work in progress */
334 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
335 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
336 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
337 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
338 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
339 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
340 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
343 /* LDAP Grouping Types *//* a work in progress */
345 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
349 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
350 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
351 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
352 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
353 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
354 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
355 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
358 /* LDAP Experimental (works in progress) Features */
359 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
360 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
361 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
365 * specific LDAP instantiations of BER types we know about
368 /* Overview of LBER tag construction
375 * 1 0 = CONTEXT-SPECIFIC
382 * | 5 ... 1 | TAG-NUMBER
386 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
387 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
389 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
390 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
392 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
393 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
395 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
397 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
398 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
399 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
400 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
402 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
403 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
405 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
407 /* LDAP Request Messages */
408 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
409 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
410 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
411 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
412 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
413 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
414 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
415 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
416 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
417 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
418 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
419 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
421 /* LDAP Response Messages */
422 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
423 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
424 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
425 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
426 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
427 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
428 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
429 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
430 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
431 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
432 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
433 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
434 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
436 #define LDAP_RES_ANY (-1)
437 #define LDAP_RES_UNSOLICITED (0)
441 #define LDAP_SASL_SIMPLE ((char*)0)
442 #define LDAP_SASL_NULL ("")
445 /* authentication methods available */
446 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
447 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
448 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
449 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
450 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
451 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
455 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
456 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
457 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
458 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
459 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
460 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
461 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
462 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
463 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
464 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
466 /* extended filter component types */
467 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
468 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
469 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
470 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
472 /* substring filter component types */
473 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
474 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
475 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
478 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
479 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
480 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
481 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
482 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
483 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
484 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
485 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
486 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
488 /* substring filter component types */
489 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
490 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
491 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
496 #define LDAP_SUCCESS 0x00
498 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
500 #define LDAP_OPERATIONS_ERROR 0x01
501 #define LDAP_PROTOCOL_ERROR 0x02
502 #define LDAP_TIMELIMIT_EXCEEDED 0x03
503 #define LDAP_SIZELIMIT_EXCEEDED 0x04
504 #define LDAP_COMPARE_FALSE 0x05
505 #define LDAP_COMPARE_TRUE 0x06
506 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
507 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
508 #define LDAP_STRONG_AUTH_REQUIRED 0x08
509 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
510 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
512 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
513 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
514 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
515 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
516 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
518 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
520 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
521 #define LDAP_UNDEFINED_TYPE 0x11
522 #define LDAP_INAPPROPRIATE_MATCHING 0x12
523 #define LDAP_CONSTRAINT_VIOLATION 0x13
524 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
525 #define LDAP_INVALID_SYNTAX 0x15
527 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
529 #define LDAP_NO_SUCH_OBJECT 0x20
530 #define LDAP_ALIAS_PROBLEM 0x21
531 #define LDAP_INVALID_DN_SYNTAX 0x22
532 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
533 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
535 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
537 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
538 #define LDAP_INAPPROPRIATE_AUTH 0x30
539 #define LDAP_INVALID_CREDENTIALS 0x31
540 #define LDAP_INSUFFICIENT_ACCESS 0x32
542 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
544 #define LDAP_BUSY 0x33
545 #define LDAP_UNAVAILABLE 0x34
546 #define LDAP_UNWILLING_TO_PERFORM 0x35
547 #define LDAP_LOOP_DETECT 0x36
549 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
551 #define LDAP_NAMING_VIOLATION 0x40
552 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
553 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
554 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
555 #define LDAP_ALREADY_EXISTS 0x44
556 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
557 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
558 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
560 #define LDAP_OTHER 0x50
562 /* LCUP operation codes (113-117) - not implemented */
563 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
564 #define LDAP_CUP_SECURITY_VIOLATION 0x72
565 #define LDAP_CUP_INVALID_DATA 0x73
566 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
567 #define LDAP_CUP_RELOAD_REQUIRED 0x75
569 /* Cancel operation codes (118-121) */
570 #define LDAP_CANCELLED 0x76
571 #define LDAP_NO_SUCH_OPERATION 0x77
572 #define LDAP_TOO_LATE 0x78
573 #define LDAP_CANNOT_CANCEL 0x79
575 /* Assertion control (122) */
576 #define LDAP_ASSERTION_FAILED 0x7A
579 /* Experimental result codes */
580 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
582 /* LDAP Sync (4096) */
583 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
586 /* Private Use result codes */
587 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
589 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
590 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
592 /* for the LDAP No-Op control */
593 #define LDAP_X_NO_OPERATION 0x410e
595 /* for the Chaining Behavior control (consecutive result codes requested;
596 * see <draft-sermersheim-ldap-chaining> ) */
597 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
598 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
599 #define LDAP_X_CANNOT_CHAIN 0x4111
605 * Based on draft-ietf-ldap-c-api-xx
606 * but with new negative code values
608 #define LDAP_API_ERROR(n) ((n)<0)
609 #define LDAP_API_RESULT(n) ((n)<=0)
611 #define LDAP_SERVER_DOWN (-1)
612 #define LDAP_LOCAL_ERROR (-2)
613 #define LDAP_ENCODING_ERROR (-3)
614 #define LDAP_DECODING_ERROR (-4)
615 #define LDAP_TIMEOUT (-5)
616 #define LDAP_AUTH_UNKNOWN (-6)
617 #define LDAP_FILTER_ERROR (-7)
618 #define LDAP_USER_CANCELLED (-8)
619 #define LDAP_PARAM_ERROR (-9)
620 #define LDAP_NO_MEMORY (-10)
621 #define LDAP_CONNECT_ERROR (-11)
622 #define LDAP_NOT_SUPPORTED (-12)
623 #define LDAP_CONTROL_NOT_FOUND (-13)
624 #define LDAP_NO_RESULTS_RETURNED (-14)
625 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
626 #define LDAP_CLIENT_LOOP (-16)
627 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
631 * This structure represents both ldap messages and ldap responses.
632 * These are really the same, except in the case of search responses,
633 * where a response has multiple messages.
636 typedef struct ldapmsg LDAPMessage;
638 /* for modifications */
639 typedef struct ldapmod {
642 #define LDAP_MOD_OP (0x0007)
643 #define LDAP_MOD_ADD (0x0000)
644 #define LDAP_MOD_DELETE (0x0001)
645 #define LDAP_MOD_REPLACE (0x0002)
646 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
647 #define LDAP_MOD_BVALUES (0x0080)
648 /* IMPORTANT: do not use code 0x1000 (or above),
649 * it is used internally by the backends!
650 * (see ldap/servers/slapd/slap.h)
656 struct berval **modv_bvals;
658 #define mod_values mod_vals.modv_strvals
659 #define mod_bvalues mod_vals.modv_bvals
663 * structure representing an ldap session which can
664 * encompass connections to multiple servers (in the
665 * face of referrals).
667 typedef struct ldap LDAP;
669 #define LDAP_DEREF_NEVER 0x00
670 #define LDAP_DEREF_SEARCHING 0x01
671 #define LDAP_DEREF_FINDING 0x02
672 #define LDAP_DEREF_ALWAYS 0x03
674 #define LDAP_NO_LIMIT 0
676 /* how many messages to retrieve results for */
677 #define LDAP_MSG_ONE 0x00
678 #define LDAP_MSG_ALL 0x01
679 #define LDAP_MSG_RECEIVED 0x02
682 * types for ldap URL handling
684 typedef struct ldap_url_desc {
685 struct ldap_url_desc *lud_next;
697 #define LDAP_URL_SUCCESS 0x00 /* Success */
698 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
699 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
701 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
702 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
703 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
704 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
705 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
706 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
707 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
708 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
711 * The API draft spec says we should declare (or cause to be declared)
712 * 'struct timeval'. We don't. See IETF LDAPext discussions.
720 ldap_get_option LDAP_P((
726 ldap_set_option LDAP_P((
729 LDAP_CONST void *invalue));
731 /* V3 REBIND Function Callback Prototype */
732 typedef int (LDAP_REBIND_PROC) LDAP_P((
733 LDAP *ld, LDAP_CONST char *url,
734 ber_tag_t request, ber_int_t msgid,
738 ldap_set_rebind_proc LDAP_P((
740 LDAP_REBIND_PROC *rebind_proc,
743 /* V3 referral selection Function Callback Prototype */
744 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
745 LDAP *ld, char ***refsp, int *cntp,
749 ldap_set_nextref_proc LDAP_P((
751 LDAP_NEXTREF_PROC *nextref_proc,
758 ldap_create_control LDAP_P((
759 LDAP_CONST char *requestOID,
762 LDAPControl **ctrlp ));
764 LDAP_F( LDAPControl * )
765 ldap_find_control LDAP_P((
766 LDAP_CONST char *oid,
767 LDAPControl **ctrls ));
770 ldap_control_free LDAP_P((
771 LDAPControl *ctrl ));
774 ldap_controls_free LDAP_P((
775 LDAPControl **ctrls ));
781 ldap_domain2dn LDAP_P((
782 LDAP_CONST char* domain,
786 ldap_dn2domain LDAP_P((
791 ldap_domain2hostlist LDAP_P((
792 LDAP_CONST char *domain,
799 ldap_extended_operation LDAP_P((
801 LDAP_CONST char *reqoid,
802 struct berval *reqdata,
803 LDAPControl **serverctrls,
804 LDAPControl **clientctrls,
808 ldap_extended_operation_s LDAP_P((
810 LDAP_CONST char *reqoid,
811 struct berval *reqdata,
812 LDAPControl **serverctrls,
813 LDAPControl **clientctrls,
815 struct berval **retdatap ));
818 ldap_parse_extended_result LDAP_P((
822 struct berval **retdatap,
826 ldap_parse_intermediate LDAP_P((
830 struct berval **retdatap,
831 LDAPControl ***serverctrls,
837 #ifdef LDAP_EXOP_GROUPING_CREATE
840 ldap_grouping_create LDAP_P((
842 LDAP_CONST char *grpoid,
843 struct berval *grpdata,
844 LDAPControl **serverctrls,
845 LDAPControl **clientctrls,
849 ldap_grouping_create_s LDAP_P((
851 LDAP_CONST char *grpoid,
852 struct berval *grpdata,
853 LDAPControl **serverctrls,
854 LDAPControl **clientctrls,
855 struct berval **retgrpcookiep,
856 struct berval **retgrpdatap ));
859 ldap_parse_grouping_create_result LDAP_P((
862 struct berval **retgrpcookiep,
863 struct berval **retgrpdatap,
864 LDAPControl ***serverctrls,
868 ldap_grouping_end LDAP_P((
870 LDAP_CONST char *grpoid,
871 struct berval *grpdata,
872 LDAPControl **serverctrls,
873 LDAPControl **clientctrls,
877 ldap_grouping_end_s LDAP_P((
879 LDAP_CONST char *grpoid,
880 struct berval *grpdata,
881 LDAPControl **serverctrls,
882 LDAPControl **clientctrls,
883 struct berval **retgrpdatap ));
886 ldap_parse_grouping_end_result LDAP_P((
889 struct berval **retgrpdatap,
890 LDAPControl ***serverctrls,
894 ldap_grouping_action_operation LDAP_P((
896 LDAP_CONST char *grpoid,
897 struct berval *grpdata,
898 LDAPControl **serverctrls,
899 LDAPControl **clientctrls,
903 ldap_grouping_action_operation_s LDAP_P((
905 LDAP_CONST char *grpoid,
906 struct berval *grpdata,
907 LDAPControl **serverctrls,
908 LDAPControl **clientctrls,
909 struct berval **retgrpcookiep,
910 struct berval **retgrpdatap ));
913 ldap_parse_grouping_action_result LDAP_P((
916 struct berval **retgrpcookiep,
917 struct berval **retgrpdatap,
918 LDAPControl ***serverctrls,
922 ldap_parse_grouping_end_notice LDAP_P((
925 struct berval **retdatap,
926 struct berval **retgrpcookiep,
927 struct berval **retgrpdatap,
931 ldap_parse_grouping_info_notice LDAP_P((
934 struct berval **retdatap,
935 struct berval **retgrpcookiep,
936 struct berval **retgrpdatap,
944 ldap_abandon_ext LDAP_P((
947 LDAPControl **serverctrls,
948 LDAPControl **clientctrls ));
952 ldap_abandon LDAP_P(( /* deprecated */
962 ldap_add_ext LDAP_P((
966 LDAPControl **serverctrls,
967 LDAPControl **clientctrls,
971 ldap_add_ext_s LDAP_P((
975 LDAPControl **serverctrls,
976 LDAPControl **clientctrls ));
980 ldap_add LDAP_P(( /* deprecated */
986 ldap_add_s LDAP_P(( /* deprecated */
997 ldap_sasl_bind LDAP_P((
1000 LDAP_CONST char *mechanism,
1001 struct berval *cred,
1002 LDAPControl **serverctrls,
1003 LDAPControl **clientctrls,
1006 /* Interaction flags (should be passed about in a control)
1007 * Automatic (default): use defaults, prompt otherwise
1008 * Interactive: prompt always
1009 * Quiet: never prompt
1011 #define LDAP_SASL_AUTOMATIC 0U
1012 #define LDAP_SASL_INTERACTIVE 1U
1013 #define LDAP_SASL_QUIET 2U
1016 * V3 SASL Interaction Function Callback Prototype
1017 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1018 * should likely passed in a control (and provided controls)
1020 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1021 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1024 ldap_sasl_interactive_bind_s LDAP_P((
1026 LDAP_CONST char *dn, /* usually NULL */
1027 LDAP_CONST char *saslMechanism,
1028 LDAPControl **serverControls,
1029 LDAPControl **clientControls,
1031 /* should be client controls */
1033 LDAP_SASL_INTERACT_PROC *proc,
1037 ldap_sasl_bind_s LDAP_P((
1039 LDAP_CONST char *dn,
1040 LDAP_CONST char *mechanism,
1041 struct berval *cred,
1042 LDAPControl **serverctrls,
1043 LDAPControl **clientctrls,
1044 struct berval **servercredp ));
1047 ldap_parse_sasl_bind_result LDAP_P((
1050 struct berval **servercredp,
1059 ldap_bind LDAP_P(( /* deprecated */
1061 LDAP_CONST char *who,
1062 LDAP_CONST char *passwd,
1066 ldap_bind_s LDAP_P(( /* deprecated */
1068 LDAP_CONST char *who,
1069 LDAP_CONST char *cred,
1076 ldap_simple_bind LDAP_P(( /* deprecated */
1078 LDAP_CONST char *who,
1079 LDAP_CONST char *passwd ));
1082 ldap_simple_bind_s LDAP_P(( /* deprecated */
1084 LDAP_CONST char *who,
1085 LDAP_CONST char *passwd ));
1093 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1095 LDAP_CONST char *who ));
1098 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1100 LDAP_CONST char *who ));
1103 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1105 LDAP_CONST char *who ));
1108 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1110 LDAP_CONST char *who ));
1113 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1115 LDAP_CONST char *who ));
1123 ldap_compare_ext LDAP_P((
1125 LDAP_CONST char *dn,
1126 LDAP_CONST char *attr,
1127 struct berval *bvalue,
1128 LDAPControl **serverctrls,
1129 LDAPControl **clientctrls,
1133 ldap_compare_ext_s LDAP_P((
1135 LDAP_CONST char *dn,
1136 LDAP_CONST char *attr,
1137 struct berval *bvalue,
1138 LDAPControl **serverctrls,
1139 LDAPControl **clientctrls ));
1143 ldap_compare LDAP_P(( /* deprecated */
1145 LDAP_CONST char *dn,
1146 LDAP_CONST char *attr,
1147 LDAP_CONST char *value ));
1150 ldap_compare_s LDAP_P(( /* deprecated */
1152 LDAP_CONST char *dn,
1153 LDAP_CONST char *attr,
1154 LDAP_CONST char *value ));
1162 ldap_delete_ext LDAP_P((
1164 LDAP_CONST char *dn,
1165 LDAPControl **serverctrls,
1166 LDAPControl **clientctrls,
1170 ldap_delete_ext_s LDAP_P((
1172 LDAP_CONST char *dn,
1173 LDAPControl **serverctrls,
1174 LDAPControl **clientctrls ));
1178 ldap_delete LDAP_P(( /* deprecated */
1180 LDAP_CONST char *dn ));
1183 ldap_delete_s LDAP_P(( /* deprecated */
1185 LDAP_CONST char *dn ));
1193 ldap_parse_result LDAP_P((
1200 LDAPControl ***serverctrls,
1204 ldap_err2string LDAP_P((
1209 ldap_result2error LDAP_P(( /* deprecated */
1215 ldap_perror LDAP_P(( /* deprecated */
1217 LDAP_CONST char *s ));
1225 ldap_modify_ext LDAP_P((
1227 LDAP_CONST char *dn,
1229 LDAPControl **serverctrls,
1230 LDAPControl **clientctrls,
1234 ldap_modify_ext_s LDAP_P((
1236 LDAP_CONST char *dn,
1238 LDAPControl **serverctrls,
1239 LDAPControl **clientctrls ));
1243 ldap_modify LDAP_P(( /* deprecated */
1245 LDAP_CONST char *dn,
1249 ldap_modify_s LDAP_P(( /* deprecated */
1251 LDAP_CONST char *dn,
1260 ldap_rename LDAP_P((
1262 LDAP_CONST char *dn,
1263 LDAP_CONST char *newrdn,
1264 LDAP_CONST char *newSuperior,
1266 LDAPControl **sctrls,
1267 LDAPControl **cctrls,
1271 ldap_rename_s LDAP_P((
1273 LDAP_CONST char *dn,
1274 LDAP_CONST char *newrdn,
1275 LDAP_CONST char *newSuperior,
1277 LDAPControl **sctrls,
1278 LDAPControl **cctrls ));
1282 ldap_rename2 LDAP_P(( /* deprecated */
1284 LDAP_CONST char *dn,
1285 LDAP_CONST char *newrdn,
1286 LDAP_CONST char *newSuperior,
1287 int deleteoldrdn ));
1290 ldap_rename2_s LDAP_P(( /* deprecated */
1292 LDAP_CONST char *dn,
1293 LDAP_CONST char *newrdn,
1294 LDAP_CONST char *newSuperior,
1295 int deleteoldrdn ));
1298 ldap_modrdn LDAP_P(( /* deprecated */
1300 LDAP_CONST char *dn,
1301 LDAP_CONST char *newrdn ));
1304 ldap_modrdn_s LDAP_P(( /* deprecated */
1306 LDAP_CONST char *dn,
1307 LDAP_CONST char *newrdn ));
1310 ldap_modrdn2 LDAP_P(( /* deprecated */
1312 LDAP_CONST char *dn,
1313 LDAP_CONST char *newrdn,
1314 int deleteoldrdn ));
1317 ldap_modrdn2_s LDAP_P(( /* deprecated */
1319 LDAP_CONST char *dn,
1320 LDAP_CONST char *newrdn,
1330 ldap_init LDAP_P(( /* deprecated */
1331 LDAP_CONST char *host,
1335 ldap_open LDAP_P(( /* deprecated */
1336 LDAP_CONST char *host,
1341 ldap_create LDAP_P((
1345 ldap_initialize LDAP_P((
1347 LDAP_CONST char *url ));
1354 ldap_tls_inplace LDAP_P((
1358 ldap_start_tls LDAP_P((
1360 LDAPControl **serverctrls,
1361 LDAPControl **clientctrls,
1365 ldap_install_tls LDAP_P((
1369 ldap_start_tls_s LDAP_P((
1371 LDAPControl **serverctrls,
1372 LDAPControl **clientctrls ));
1377 LDAP_F( LDAPMessage * )
1378 ldap_first_message LDAP_P((
1380 LDAPMessage *chain ));
1382 LDAP_F( LDAPMessage * )
1383 ldap_next_message LDAP_P((
1385 LDAPMessage *msg ));
1388 ldap_count_messages LDAP_P((
1390 LDAPMessage *chain ));
1395 LDAP_F( LDAPMessage * )
1396 ldap_first_reference LDAP_P((
1398 LDAPMessage *chain ));
1400 LDAP_F( LDAPMessage * )
1401 ldap_next_reference LDAP_P((
1403 LDAPMessage *ref ));
1406 ldap_count_references LDAP_P((
1408 LDAPMessage *chain ));
1411 ldap_parse_reference LDAP_P((
1415 LDAPControl ***serverctrls,
1422 LDAP_F( LDAPMessage * )
1423 ldap_first_entry LDAP_P((
1425 LDAPMessage *chain ));
1427 LDAP_F( LDAPMessage * )
1428 ldap_next_entry LDAP_P((
1430 LDAPMessage *entry ));
1433 ldap_count_entries LDAP_P((
1435 LDAPMessage *chain ));
1438 ldap_get_entry_controls LDAP_P((
1441 LDAPControl ***serverctrls));
1447 LDAP_F( LDAPMessage * )
1448 ldap_delete_result_entry LDAP_P((
1453 ldap_add_result_entry LDAP_P((
1462 ldap_get_dn LDAP_P((
1464 LDAPMessage *entry ));
1466 typedef struct ldap_ava {
1467 struct berval la_attr;
1468 struct berval la_value;
1470 #define LDAP_AVA_NULL 0x0000U
1471 #define LDAP_AVA_STRING 0x0001U
1472 #define LDAP_AVA_BINARY 0x0002U
1473 #define LDAP_AVA_NONPRINTABLE 0x0004U
1474 #define LDAP_AVA_FREE_ATTR 0x0010U
1475 #define LDAP_AVA_FREE_VALUE 0x0020U
1480 typedef LDAPAVA** LDAPRDN;
1481 typedef LDAPRDN* LDAPDN;
1484 #define LDAP_DN_FORMAT_LDAP 0x0000U
1485 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1486 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1487 #define LDAP_DN_FORMAT_DCE 0x0030U
1488 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1489 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1490 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1491 #define LDAP_DN_FORMAT_MASK 0x00F0U
1494 #define LDAP_DN_PRETTY 0x0100U
1495 #define LDAP_DN_SKIP 0x0200U
1496 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1497 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1498 #define LDAP_DN_PEDANTIC 0xF000U
1500 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1501 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1510 ldap_str2dn LDAP_P((
1511 LDAP_CONST char *str,
1522 ldap_dn2str LDAP_P((
1528 ldap_bv2rdn LDAP_P((
1535 ldap_str2rdn LDAP_P((
1536 LDAP_CONST char *str,
1542 ldap_rdn2bv LDAP_P((
1548 ldap_rdn2str LDAP_P((
1554 ldap_dn_normalize LDAP_P((
1555 LDAP_CONST char *in, unsigned iflags,
1556 char **out, unsigned oflags ));
1559 ldap_dn2ufn LDAP_P(( /* deprecated */
1560 LDAP_CONST char *dn ));
1563 ldap_explode_dn LDAP_P(( /* deprecated */
1564 LDAP_CONST char *dn,
1568 ldap_explode_rdn LDAP_P(( /* deprecated */
1569 LDAP_CONST char *rdn,
1572 typedef int LDAPDN_rewrite_func
1573 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1576 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1577 LDAPDN_rewrite_func *func, unsigned flags ));
1580 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1583 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1586 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1589 ldap_get_dn_ber LDAP_P((
1590 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1593 ldap_get_attribute_ber LDAP_P((
1594 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1595 struct berval **vals ));
1601 ldap_first_attribute LDAP_P((
1604 BerElement **ber ));
1607 ldap_next_attribute LDAP_P((
1616 LDAP_F( struct berval ** )
1617 ldap_get_values_len LDAP_P((
1620 LDAP_CONST char *target ));
1623 ldap_count_values_len LDAP_P((
1624 struct berval **vals ));
1627 ldap_value_free_len LDAP_P((
1628 struct berval **vals ));
1632 ldap_get_values LDAP_P(( /* deprecated */
1635 LDAP_CONST char *target ));
1638 ldap_count_values LDAP_P(( /* deprecated */
1642 ldap_value_free LDAP_P(( /* deprecated */
1650 ldap_result LDAP_P((
1654 struct timeval *timeout,
1655 LDAPMessage **result ));
1658 ldap_msgtype LDAP_P((
1666 ldap_msgfree LDAP_P((
1670 ldap_msgdelete LDAP_P((
1679 ldap_bv2escaped_filter_value LDAP_P((
1681 struct berval *out ));
1684 ldap_search_ext LDAP_P((
1686 LDAP_CONST char *base,
1688 LDAP_CONST char *filter,
1691 LDAPControl **serverctrls,
1692 LDAPControl **clientctrls,
1693 struct timeval *timeout,
1698 ldap_search_ext_s LDAP_P((
1700 LDAP_CONST char *base,
1702 LDAP_CONST char *filter,
1705 LDAPControl **serverctrls,
1706 LDAPControl **clientctrls,
1707 struct timeval *timeout,
1709 LDAPMessage **res ));
1713 ldap_search LDAP_P(( /* deprecated */
1715 LDAP_CONST char *base,
1717 LDAP_CONST char *filter,
1722 ldap_search_s LDAP_P(( /* deprecated */
1724 LDAP_CONST char *base,
1726 LDAP_CONST char *filter,
1729 LDAPMessage **res ));
1732 ldap_search_st LDAP_P(( /* deprecated */
1734 LDAP_CONST char *base,
1736 LDAP_CONST char *filter,
1739 struct timeval *timeout,
1740 LDAPMessage **res ));
1747 ldap_unbind_ext LDAP_P((
1749 LDAPControl **serverctrls,
1750 LDAPControl **clientctrls));
1753 ldap_unbind_ext_s LDAP_P((
1755 LDAPControl **serverctrls,
1756 LDAPControl **clientctrls));
1760 ldap_unbind LDAP_P(( /* deprecated */
1764 ldap_unbind_s LDAP_P(( /* deprecated */
1772 ldap_put_vrFilter LDAP_P((
1781 ldap_memalloc LDAP_P((
1785 ldap_memrealloc LDAP_P((
1790 ldap_memcalloc LDAP_P((
1795 ldap_memfree LDAP_P((
1799 ldap_memvfree LDAP_P((
1803 ldap_strdup LDAP_P((
1804 LDAP_CONST char * ));
1807 ldap_mods_free LDAP_P((
1814 * in sort.c (deprecated)
1816 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1817 LDAP_CONST char *left,
1818 LDAP_CONST char *right ));
1820 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1821 LDAP_CONST void *left,
1822 LDAP_CONST void *right ));
1824 LDAP_F( int ) /* deprecated */
1825 ldap_sort_entries LDAP_P(( LDAP *ld,
1826 LDAPMessage **chain,
1827 LDAP_CONST char *attr,
1828 LDAP_SORT_AD_CMP_PROC *cmp ));
1830 LDAP_F( int ) /* deprecated */
1831 ldap_sort_values LDAP_P((
1834 LDAP_SORT_AV_CMP_PROC *cmp ));
1836 LDAP_F( int ) /* deprecated */
1837 ldap_sort_strcasecmp LDAP_P((
1839 LDAP_CONST void *b ));
1846 ldap_is_ldap_url LDAP_P((
1847 LDAP_CONST char *url ));
1850 ldap_is_ldaps_url LDAP_P((
1851 LDAP_CONST char *url ));
1854 ldap_is_ldapi_url LDAP_P((
1855 LDAP_CONST char *url ));
1858 ldap_url_parse LDAP_P((
1859 LDAP_CONST char *url,
1860 LDAPURLDesc **ludpp ));
1863 ldap_url_desc2str LDAP_P((
1864 LDAPURLDesc *ludp ));
1867 ldap_free_urldesc LDAP_P((
1868 LDAPURLDesc *ludp ));
1872 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1875 #define LDAP_API_FEATURE_CANCEL 1000
1878 ldap_cancel LDAP_P(( LDAP *ld,
1880 LDAPControl **sctrls,
1881 LDAPControl **cctrls,
1885 ldap_cancel_s LDAP_P(( LDAP *ld,
1887 LDAPControl **sctrl,
1888 LDAPControl **cctrl ));
1891 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1894 #define LDAP_API_FEATURE_TURN 1000
1897 ldap_turn LDAP_P(( LDAP *ld,
1899 LDAP_CONST char* identifier,
1900 LDAPControl **sctrls,
1901 LDAPControl **cctrls,
1905 ldap_turn_s LDAP_P(( LDAP *ld,
1907 LDAP_CONST char* identifier,
1908 LDAPControl **sctrl,
1909 LDAPControl **cctrl ));
1912 * LDAP Server Side Sort
1915 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1917 /* structure for a sort-key */
1918 typedef struct ldapsortkey {
1919 char * attributeType;
1920 char * orderingRule;
1925 ldap_create_sort_keylist LDAP_P((
1926 LDAPSortKey ***sortKeyList,
1930 ldap_free_sort_keylist LDAP_P((
1931 LDAPSortKey **sortkeylist ));
1934 ldap_create_sort_control LDAP_P((
1936 LDAPSortKey **keyList,
1938 LDAPControl **ctrlp ));
1941 ldap_parse_sort_control LDAP_P((
1943 LDAPControl **ctrlp,
1944 unsigned long *result,
1945 char **attribute ));
1949 * LDAP Virtual List View
1952 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1954 /* structure for virtual list */
1955 typedef struct ldapvlvinfo {
1957 unsigned long ldvlv_before_count;
1958 unsigned long ldvlv_after_count;
1959 unsigned long ldvlv_offset;
1960 unsigned long ldvlv_count;
1961 struct berval * ldvlv_attrvalue;
1962 struct berval * ldvlv_context;
1963 void * ldvlv_extradata;
1967 ldap_create_vlv_control LDAP_P((
1969 LDAPVLVInfo *ldvlistp,
1970 LDAPControl **ctrlp ));
1973 ldap_parse_vlv_control LDAP_P((
1975 LDAPControl **ctrls,
1976 unsigned long *target_posp,
1977 unsigned long *list_countp,
1978 struct berval **contextp,
1985 #ifdef LDAP_GROUP_TRANSACTION
1987 ldap_parse_txn_create LDAP_P((
1990 struct berval **cookie ));
1993 ldap_txn_create LDAP_P((
1995 LDAPControl **sctrls,
1996 LDAPControl **cctrls,
2000 ldap_txn_create_s LDAP_P((
2002 struct berval **cookie,
2003 LDAPControl **sctrls,
2004 LDAPControl **cctrls ));
2007 ldap_txn_end LDAP_P((
2009 struct berval *cookie,
2011 LDAPControl **sctrls,
2012 LDAPControl **cctrls,
2016 ldap_txn_end_s LDAP_P((
2018 struct berval *cookie,
2020 LDAPControl **sctrls,
2021 LDAPControl **cctrls ));
2028 #define LDAP_API_FEATURE_WHOAMI 1000
2031 ldap_parse_whoami LDAP_P((
2034 struct berval **authzid ));
2037 ldap_whoami LDAP_P(( LDAP *ld,
2038 LDAPControl **sctrls,
2039 LDAPControl **cctrls,
2043 ldap_whoami_s LDAP_P((
2045 struct berval **authzid,
2046 LDAPControl **sctrls,
2047 LDAPControl **cctrls ));
2050 * LDAP Password Modify
2053 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2056 ldap_parse_passwd LDAP_P((
2059 struct berval *newpasswd ));
2062 ldap_passwd LDAP_P(( LDAP *ld,
2063 struct berval *user,
2064 struct berval *oldpw,
2065 struct berval *newpw,
2066 LDAPControl **sctrls,
2067 LDAPControl **cctrls,
2071 ldap_passwd_s LDAP_P((
2073 struct berval *user,
2074 struct berval *oldpw,
2075 struct berval *newpw,
2076 struct berval *newpasswd,
2077 LDAPControl **sctrls,
2078 LDAPControl **cctrls ));
2080 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2082 * LDAP Password Policy controls
2085 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2087 typedef enum passpolicyerror_enum {
2088 PP_passwordExpired = 0,
2089 PP_accountLocked = 1,
2090 PP_changeAfterReset = 2,
2091 PP_passwordModNotAllowed = 3,
2092 PP_mustSupplyOldPassword = 4,
2093 PP_insufficientPasswordQuality = 5,
2094 PP_passwordTooShort = 6,
2095 PP_passwordTooYoung = 7,
2096 PP_passwordInHistory = 8,
2098 } LDAPPasswordPolicyError;
2101 ldap_create_passwordpolicy_control LDAP_P((
2103 LDAPControl **ctrlp ));
2106 ldap_parse_passwordpolicy_control LDAP_P((
2111 LDAPPasswordPolicyError *errorp ));
2113 LDAP_F( const char * )
2114 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2115 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2118 #endif /* _LDAP_H */