2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2007 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 4511: 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_DIAGNOSTIC_MESSAGE 0x0032
108 #define LDAP_OPT_ERROR_STRING LDAP_OPT_DIAGNOSTIC_MESSAGE
109 #define LDAP_OPT_MATCHED_DN 0x0033
110 /* 0x0034 - 0x3fff not defined */
113 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
115 /* private and experimental options */
116 /* OpenLDAP specific options */
117 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
118 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
119 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
120 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
121 #define LDAP_OPT_URI 0x5006
122 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
123 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
124 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */
126 /* OpenLDAP TLS options */
127 #define LDAP_OPT_X_TLS 0x6000
128 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX */
129 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
130 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
131 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
132 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
133 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
134 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
135 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
136 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
137 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
138 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
139 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
140 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
141 #define LDAP_OPT_X_TLS_DHFILE 0x600e
142 #define LDAP_OPT_X_TLS_NEWCTX 0x600f
144 #define LDAP_OPT_X_TLS_NEVER 0
145 #define LDAP_OPT_X_TLS_HARD 1
146 #define LDAP_OPT_X_TLS_DEMAND 2
147 #define LDAP_OPT_X_TLS_ALLOW 3
148 #define LDAP_OPT_X_TLS_TRY 4
150 #define LDAP_OPT_X_TLS_CRL_NONE 0
151 #define LDAP_OPT_X_TLS_CRL_PEER 1
152 #define LDAP_OPT_X_TLS_CRL_ALL 2
154 /* OpenLDAP SASL options */
155 #define LDAP_OPT_X_SASL_MECH 0x6100
156 #define LDAP_OPT_X_SASL_REALM 0x6101
157 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
158 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
159 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
160 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
161 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
162 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
163 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
164 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
166 /* Private API Extensions -- reserved for application use */
167 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
170 * ldap_get_option() and ldap_set_option() return values.
171 * As later versions may return other values indicating
172 * failure, current applications should only compare returned
173 * value against LDAP_OPT_SUCCESS.
175 #define LDAP_OPT_SUCCESS 0
176 #define LDAP_OPT_ERROR (-1)
178 /* option on/off values */
179 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
180 #define LDAP_OPT_OFF ((void *) 0)
182 typedef struct ldapapiinfo {
183 int ldapai_info_version; /* version of LDAPAPIInfo */
184 #define LDAP_API_INFO_VERSION (1)
185 int ldapai_api_version; /* revision of API supported */
186 int ldapai_protocol_version; /* highest LDAP version supported */
187 char **ldapai_extensions; /* names of API extensions */
188 char *ldapai_vendor_name; /* name of supplier */
189 int ldapai_vendor_version; /* supplier-specific version * 100 */
192 typedef struct ldap_apifeature_info {
193 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
194 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
195 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
196 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
197 } LDAPAPIFeatureInfo;
200 * LDAP Control structure
202 typedef struct ldapcontrol {
203 char * ldctl_oid; /* numericoid of control */
204 struct berval ldctl_value; /* encoded value of control */
205 char ldctl_iscritical; /* criticality */
209 /* standard track controls */
210 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
211 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
212 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
214 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
216 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
217 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
218 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
220 /* standard track - not implemented in slapd(8) */
221 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
222 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
224 /* non-standard track controls */
225 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
227 /* LDAP Content Synchronization Operation -- RFC 4533 */
228 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
229 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
230 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
231 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
232 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
234 #define LDAP_SYNC_NONE 0x00
235 #define LDAP_SYNC_REFRESH_ONLY 0x01
236 #define LDAP_SYNC_RESERVED 0x02
237 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
239 #define LDAP_SYNC_REFRESH_PRESENTS 0
240 #define LDAP_SYNC_REFRESH_DELETES 1
242 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
243 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
244 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
245 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
247 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
248 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
249 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
250 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
252 #define LDAP_SYNC_PRESENT 0
253 #define LDAP_SYNC_ADD 1
254 #define LDAP_SYNC_MODIFY 2
255 #define LDAP_SYNC_DELETE 3
258 /* Password policy Controls *//* work in progress */
259 /* ITS#3458: released; disabled by default */
260 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
261 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
263 /* various works in progress */
264 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
265 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
266 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
267 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
268 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
269 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
270 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
273 /* LDAP Chaining Behavior Control *//* work in progress */
274 /* <draft-sermersheim-ldap-chaining>;
275 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
276 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
278 #define LDAP_CHAINING_PREFERRED 0
279 #define LDAP_CHAINING_REQUIRED 1
280 #define LDAP_REFERRALS_PREFERRED 2
281 #define LDAP_REFERRALS_REQUIRED 3
283 /* MS Active Directory controls (for compatibility) */
284 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
285 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
286 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
287 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
288 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
289 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
291 /* MS Active Directory controls - not implemented in slapd(8) */
292 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
293 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
295 /* various expired works */
296 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
297 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
298 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
299 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
300 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
302 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
303 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
307 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
308 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
310 /* LDAP VLV *//* not implemented in slapd(8) */
311 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
312 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
315 /* LDAP Unsolicited Notifications */
316 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
317 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
319 /* LDAP Extended Operations */
320 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
322 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
325 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
326 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
328 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
329 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
331 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
332 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
333 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
334 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
336 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
337 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
339 /* various works in progress */
340 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
341 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
343 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
344 /* a work in progress */
345 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
346 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
347 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
348 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
349 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
350 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
351 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
352 LDAP_X_DISTPROC_BASE ".6"
353 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
354 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
355 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
356 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
357 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
360 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
361 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
362 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
363 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
364 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
368 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
369 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
370 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
371 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
372 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
373 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
374 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
376 /* LDAP Experimental (works in progress) Features */
377 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
378 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
379 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
382 * specific LDAP instantiations of BER types we know about
385 /* Overview of LBER tag construction
392 * 1 0 = CONTEXT-SPECIFIC
399 * | 5 ... 1 | TAG-NUMBER
403 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
404 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
406 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
407 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
409 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
410 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
412 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
414 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
415 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
416 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
417 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
419 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
420 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
422 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
424 /* LDAP Request Messages */
425 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
426 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
427 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
428 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
429 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
430 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
431 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
432 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
433 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
434 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
435 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
436 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
438 /* LDAP Response Messages */
439 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
440 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
441 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
442 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
443 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
444 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
445 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
446 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
447 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
448 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
449 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
450 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
451 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
453 #define LDAP_RES_ANY (-1)
454 #define LDAP_RES_UNSOLICITED (0)
458 #define LDAP_SASL_SIMPLE ((char*)0)
459 #define LDAP_SASL_NULL ("")
462 /* authentication methods available */
463 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
464 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
465 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
466 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
467 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
468 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
472 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
473 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
474 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
475 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
476 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
477 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
478 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
479 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
480 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
481 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
483 /* extended filter component types */
484 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
485 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
486 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
487 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
489 /* substring filter component types */
490 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
491 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
492 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
495 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
496 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
497 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
498 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
499 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
500 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
501 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
502 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
503 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
505 /* substring filter component types */
506 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
507 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
508 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
513 #define LDAP_SUCCESS 0x00
515 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
517 #define LDAP_OPERATIONS_ERROR 0x01
518 #define LDAP_PROTOCOL_ERROR 0x02
519 #define LDAP_TIMELIMIT_EXCEEDED 0x03
520 #define LDAP_SIZELIMIT_EXCEEDED 0x04
521 #define LDAP_COMPARE_FALSE 0x05
522 #define LDAP_COMPARE_TRUE 0x06
523 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
524 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
525 #define LDAP_STRONG_AUTH_REQUIRED 0x08
526 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
527 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
529 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
530 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
531 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
532 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
533 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
535 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
537 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
538 #define LDAP_UNDEFINED_TYPE 0x11
539 #define LDAP_INAPPROPRIATE_MATCHING 0x12
540 #define LDAP_CONSTRAINT_VIOLATION 0x13
541 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
542 #define LDAP_INVALID_SYNTAX 0x15
544 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
546 #define LDAP_NO_SUCH_OBJECT 0x20
547 #define LDAP_ALIAS_PROBLEM 0x21
548 #define LDAP_INVALID_DN_SYNTAX 0x22
549 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
550 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
552 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
554 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
555 #define LDAP_INAPPROPRIATE_AUTH 0x30
556 #define LDAP_INVALID_CREDENTIALS 0x31
557 #define LDAP_INSUFFICIENT_ACCESS 0x32
559 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
561 #define LDAP_BUSY 0x33
562 #define LDAP_UNAVAILABLE 0x34
563 #define LDAP_UNWILLING_TO_PERFORM 0x35
564 #define LDAP_LOOP_DETECT 0x36
566 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
568 #define LDAP_NAMING_VIOLATION 0x40
569 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
570 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
571 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
572 #define LDAP_ALREADY_EXISTS 0x44
573 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
574 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
575 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
577 #define LDAP_OTHER 0x50
579 /* LCUP operation codes (113-117) - not implemented */
580 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
581 #define LDAP_CUP_SECURITY_VIOLATION 0x72
582 #define LDAP_CUP_INVALID_DATA 0x73
583 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
584 #define LDAP_CUP_RELOAD_REQUIRED 0x75
586 /* Cancel operation codes (118-121) */
587 #define LDAP_CANCELLED 0x76
588 #define LDAP_NO_SUCH_OPERATION 0x77
589 #define LDAP_TOO_LATE 0x78
590 #define LDAP_CANNOT_CANCEL 0x79
592 /* Assertion control (122) */
593 #define LDAP_ASSERTION_FAILED 0x7A
595 /* Proxied Authorization Denied (123) */
596 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
598 /* Experimental result codes */
599 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
601 /* LDAP Sync (4096) */
602 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
605 /* Private Use result codes */
606 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
608 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
609 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
611 /* for the LDAP No-Op control */
612 #define LDAP_X_NO_OPERATION 0x410e
614 /* for the Chaining Behavior control (consecutive result codes requested;
615 * see <draft-sermersheim-ldap-chaining> ) */
616 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
617 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
618 #define LDAP_X_CANNOT_CHAIN 0x4111
621 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
622 #ifdef LDAP_X_DISTPROC_BASE
623 #define LDAP_X_INVALIDREFERENCE 0x4112
627 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
628 #define LDAP_X_TXN_ID_INVALID 0x4121
633 * Based on draft-ietf-ldap-c-api-xx
634 * but with new negative code values
636 #define LDAP_API_ERROR(n) ((n)<0)
637 #define LDAP_API_RESULT(n) ((n)<=0)
639 #define LDAP_SERVER_DOWN (-1)
640 #define LDAP_LOCAL_ERROR (-2)
641 #define LDAP_ENCODING_ERROR (-3)
642 #define LDAP_DECODING_ERROR (-4)
643 #define LDAP_TIMEOUT (-5)
644 #define LDAP_AUTH_UNKNOWN (-6)
645 #define LDAP_FILTER_ERROR (-7)
646 #define LDAP_USER_CANCELLED (-8)
647 #define LDAP_PARAM_ERROR (-9)
648 #define LDAP_NO_MEMORY (-10)
649 #define LDAP_CONNECT_ERROR (-11)
650 #define LDAP_NOT_SUPPORTED (-12)
651 #define LDAP_CONTROL_NOT_FOUND (-13)
652 #define LDAP_NO_RESULTS_RETURNED (-14)
653 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
654 #define LDAP_CLIENT_LOOP (-16)
655 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
659 * This structure represents both ldap messages and ldap responses.
660 * These are really the same, except in the case of search responses,
661 * where a response has multiple messages.
664 typedef struct ldapmsg LDAPMessage;
666 /* for modifications */
667 typedef struct ldapmod {
670 #define LDAP_MOD_OP (0x0007)
671 #define LDAP_MOD_ADD (0x0000)
672 #define LDAP_MOD_DELETE (0x0001)
673 #define LDAP_MOD_REPLACE (0x0002)
674 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
675 #define LDAP_MOD_BVALUES (0x0080)
676 /* IMPORTANT: do not use code 0x1000 (or above),
677 * it is used internally by the backends!
678 * (see ldap/servers/slapd/slap.h)
684 struct berval **modv_bvals;
686 #define mod_values mod_vals.modv_strvals
687 #define mod_bvalues mod_vals.modv_bvals
691 * structure representing an ldap session which can
692 * encompass connections to multiple servers (in the
693 * face of referrals).
695 typedef struct ldap LDAP;
697 #define LDAP_DEREF_NEVER 0x00
698 #define LDAP_DEREF_SEARCHING 0x01
699 #define LDAP_DEREF_FINDING 0x02
700 #define LDAP_DEREF_ALWAYS 0x03
702 #define LDAP_NO_LIMIT 0
704 /* how many messages to retrieve results for */
705 #define LDAP_MSG_ONE 0x00
706 #define LDAP_MSG_ALL 0x01
707 #define LDAP_MSG_RECEIVED 0x02
710 * types for ldap URL handling
712 typedef struct ldap_url_desc {
713 struct ldap_url_desc *lud_next;
725 #define LDAP_URL_SUCCESS 0x00 /* Success */
726 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
727 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
729 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
730 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
731 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
732 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
733 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
734 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
735 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
736 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
739 * The API draft spec says we should declare (or cause to be declared)
740 * 'struct timeval'. We don't. See IETF LDAPext discussions.
748 ldap_get_option LDAP_P((
754 ldap_set_option LDAP_P((
757 LDAP_CONST void *invalue));
759 /* V3 REBIND Function Callback Prototype */
760 typedef int (LDAP_REBIND_PROC) LDAP_P((
761 LDAP *ld, LDAP_CONST char *url,
762 ber_tag_t request, ber_int_t msgid,
766 ldap_set_rebind_proc LDAP_P((
768 LDAP_REBIND_PROC *rebind_proc,
771 /* V3 referral selection Function Callback Prototype */
772 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
773 LDAP *ld, char ***refsp, int *cntp,
777 ldap_set_nextref_proc LDAP_P((
779 LDAP_NEXTREF_PROC *nextref_proc,
782 /* V3 URLLIST Function Callback Prototype */
783 typedef int (LDAP_URLLIST_PROC) LDAP_P((
785 LDAPURLDesc **urllist,
790 ldap_set_urllist_proc LDAP_P((
792 LDAP_URLLIST_PROC *urllist_proc,
799 ldap_create_control LDAP_P((
800 LDAP_CONST char *requestOID,
803 LDAPControl **ctrlp ));
805 LDAP_F( LDAPControl * )
806 ldap_find_control LDAP_P((
807 LDAP_CONST char *oid,
808 LDAPControl **ctrls ));
811 ldap_control_free LDAP_P((
812 LDAPControl *ctrl ));
815 ldap_controls_free LDAP_P((
816 LDAPControl **ctrls ));
822 ldap_domain2dn LDAP_P((
823 LDAP_CONST char* domain,
827 ldap_dn2domain LDAP_P((
832 ldap_domain2hostlist LDAP_P((
833 LDAP_CONST char *domain,
840 ldap_extended_operation LDAP_P((
842 LDAP_CONST char *reqoid,
843 struct berval *reqdata,
844 LDAPControl **serverctrls,
845 LDAPControl **clientctrls,
849 ldap_extended_operation_s LDAP_P((
851 LDAP_CONST char *reqoid,
852 struct berval *reqdata,
853 LDAPControl **serverctrls,
854 LDAPControl **clientctrls,
856 struct berval **retdatap ));
859 ldap_parse_extended_result LDAP_P((
863 struct berval **retdatap,
867 ldap_parse_intermediate LDAP_P((
871 struct berval **retdatap,
872 LDAPControl ***serverctrls,
880 ldap_abandon_ext LDAP_P((
883 LDAPControl **serverctrls,
884 LDAPControl **clientctrls ));
888 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
897 ldap_add_ext LDAP_P((
901 LDAPControl **serverctrls,
902 LDAPControl **clientctrls,
906 ldap_add_ext_s LDAP_P((
910 LDAPControl **serverctrls,
911 LDAPControl **clientctrls ));
915 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
921 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
932 ldap_sasl_bind LDAP_P((
935 LDAP_CONST char *mechanism,
937 LDAPControl **serverctrls,
938 LDAPControl **clientctrls,
941 /* Interaction flags (should be passed about in a control)
942 * Automatic (default): use defaults, prompt otherwise
943 * Interactive: prompt always
944 * Quiet: never prompt
946 #define LDAP_SASL_AUTOMATIC 0U
947 #define LDAP_SASL_INTERACTIVE 1U
948 #define LDAP_SASL_QUIET 2U
951 * V3 SASL Interaction Function Callback Prototype
952 * when using Cyrus SASL, interact is pointer to sasl_interact_t
953 * should likely passed in a control (and provided controls)
955 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
956 LDAP *ld, unsigned flags, void* defaults, void *interact ));
959 ldap_sasl_interactive_bind_s LDAP_P((
961 LDAP_CONST char *dn, /* usually NULL */
962 LDAP_CONST char *saslMechanism,
963 LDAPControl **serverControls,
964 LDAPControl **clientControls,
966 /* should be client controls */
968 LDAP_SASL_INTERACT_PROC *proc,
972 ldap_sasl_bind_s LDAP_P((
975 LDAP_CONST char *mechanism,
977 LDAPControl **serverctrls,
978 LDAPControl **clientctrls,
979 struct berval **servercredp ));
982 ldap_parse_sasl_bind_result LDAP_P((
985 struct berval **servercredp,
994 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
996 LDAP_CONST char *who,
997 LDAP_CONST char *passwd,
1001 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1003 LDAP_CONST char *who,
1004 LDAP_CONST char *cred,
1011 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1013 LDAP_CONST char *who,
1014 LDAP_CONST char *passwd ));
1017 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1019 LDAP_CONST char *who,
1020 LDAP_CONST char *passwd ));
1025 * (deprecated - use SASL instead)
1028 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1030 LDAP_CONST char *who ));
1033 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1035 LDAP_CONST char *who ));
1038 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1040 LDAP_CONST char *who ));
1043 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1045 LDAP_CONST char *who ));
1048 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1050 LDAP_CONST char *who ));
1058 ldap_compare_ext LDAP_P((
1060 LDAP_CONST char *dn,
1061 LDAP_CONST char *attr,
1062 struct berval *bvalue,
1063 LDAPControl **serverctrls,
1064 LDAPControl **clientctrls,
1068 ldap_compare_ext_s LDAP_P((
1070 LDAP_CONST char *dn,
1071 LDAP_CONST char *attr,
1072 struct berval *bvalue,
1073 LDAPControl **serverctrls,
1074 LDAPControl **clientctrls ));
1078 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1080 LDAP_CONST char *dn,
1081 LDAP_CONST char *attr,
1082 LDAP_CONST char *value ));
1085 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1087 LDAP_CONST char *dn,
1088 LDAP_CONST char *attr,
1089 LDAP_CONST char *value ));
1097 ldap_delete_ext LDAP_P((
1099 LDAP_CONST char *dn,
1100 LDAPControl **serverctrls,
1101 LDAPControl **clientctrls,
1105 ldap_delete_ext_s LDAP_P((
1107 LDAP_CONST char *dn,
1108 LDAPControl **serverctrls,
1109 LDAPControl **clientctrls ));
1113 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1115 LDAP_CONST char *dn ));
1118 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1120 LDAP_CONST char *dn ));
1128 ldap_parse_result LDAP_P((
1135 LDAPControl ***serverctrls,
1139 ldap_err2string LDAP_P((
1144 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1150 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1152 LDAP_CONST char *s ));
1160 ldap_modify_ext LDAP_P((
1162 LDAP_CONST char *dn,
1164 LDAPControl **serverctrls,
1165 LDAPControl **clientctrls,
1169 ldap_modify_ext_s LDAP_P((
1171 LDAP_CONST char *dn,
1173 LDAPControl **serverctrls,
1174 LDAPControl **clientctrls ));
1178 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1180 LDAP_CONST char *dn,
1184 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1186 LDAP_CONST char *dn,
1195 ldap_rename LDAP_P((
1197 LDAP_CONST char *dn,
1198 LDAP_CONST char *newrdn,
1199 LDAP_CONST char *newSuperior,
1201 LDAPControl **sctrls,
1202 LDAPControl **cctrls,
1206 ldap_rename_s LDAP_P((
1208 LDAP_CONST char *dn,
1209 LDAP_CONST char *newrdn,
1210 LDAP_CONST char *newSuperior,
1212 LDAPControl **sctrls,
1213 LDAPControl **cctrls ));
1217 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1219 LDAP_CONST char *dn,
1220 LDAP_CONST char *newrdn,
1221 LDAP_CONST char *newSuperior,
1222 int deleteoldrdn ));
1225 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1227 LDAP_CONST char *dn,
1228 LDAP_CONST char *newrdn,
1229 LDAP_CONST char *newSuperior,
1230 int deleteoldrdn ));
1233 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1235 LDAP_CONST char *dn,
1236 LDAP_CONST char *newrdn ));
1239 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1241 LDAP_CONST char *dn,
1242 LDAP_CONST char *newrdn ));
1245 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1247 LDAP_CONST char *dn,
1248 LDAP_CONST char *newrdn,
1249 int deleteoldrdn ));
1252 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1254 LDAP_CONST char *dn,
1255 LDAP_CONST char *newrdn,
1265 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1266 LDAP_CONST char *host,
1270 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1271 LDAP_CONST char *host,
1276 ldap_create LDAP_P((
1280 ldap_initialize LDAP_P((
1282 LDAP_CONST char *url ));
1289 ldap_tls_inplace LDAP_P((
1293 ldap_start_tls LDAP_P((
1295 LDAPControl **serverctrls,
1296 LDAPControl **clientctrls,
1300 ldap_install_tls LDAP_P((
1304 ldap_start_tls_s LDAP_P((
1306 LDAPControl **serverctrls,
1307 LDAPControl **clientctrls ));
1312 LDAP_F( LDAPMessage * )
1313 ldap_first_message LDAP_P((
1315 LDAPMessage *chain ));
1317 LDAP_F( LDAPMessage * )
1318 ldap_next_message LDAP_P((
1320 LDAPMessage *msg ));
1323 ldap_count_messages LDAP_P((
1325 LDAPMessage *chain ));
1330 LDAP_F( LDAPMessage * )
1331 ldap_first_reference LDAP_P((
1333 LDAPMessage *chain ));
1335 LDAP_F( LDAPMessage * )
1336 ldap_next_reference LDAP_P((
1338 LDAPMessage *ref ));
1341 ldap_count_references LDAP_P((
1343 LDAPMessage *chain ));
1346 ldap_parse_reference LDAP_P((
1350 LDAPControl ***serverctrls,
1357 LDAP_F( LDAPMessage * )
1358 ldap_first_entry LDAP_P((
1360 LDAPMessage *chain ));
1362 LDAP_F( LDAPMessage * )
1363 ldap_next_entry LDAP_P((
1365 LDAPMessage *entry ));
1368 ldap_count_entries LDAP_P((
1370 LDAPMessage *chain ));
1373 ldap_get_entry_controls LDAP_P((
1376 LDAPControl ***serverctrls));
1382 LDAP_F( LDAPMessage * )
1383 ldap_delete_result_entry LDAP_P((
1388 ldap_add_result_entry LDAP_P((
1397 ldap_get_dn LDAP_P((
1399 LDAPMessage *entry ));
1401 typedef struct ldap_ava {
1402 struct berval la_attr;
1403 struct berval la_value;
1405 #define LDAP_AVA_NULL 0x0000U
1406 #define LDAP_AVA_STRING 0x0001U
1407 #define LDAP_AVA_BINARY 0x0002U
1408 #define LDAP_AVA_NONPRINTABLE 0x0004U
1409 #define LDAP_AVA_FREE_ATTR 0x0010U
1410 #define LDAP_AVA_FREE_VALUE 0x0020U
1415 typedef LDAPAVA** LDAPRDN;
1416 typedef LDAPRDN* LDAPDN;
1419 #define LDAP_DN_FORMAT_LDAP 0x0000U
1420 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1421 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1422 #define LDAP_DN_FORMAT_DCE 0x0030U
1423 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1424 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1425 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1426 #define LDAP_DN_FORMAT_MASK 0x00F0U
1429 #define LDAP_DN_PRETTY 0x0100U
1430 #define LDAP_DN_SKIP 0x0200U
1431 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1432 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1433 #define LDAP_DN_PEDANTIC 0xF000U
1435 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1436 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1445 ldap_str2dn LDAP_P((
1446 LDAP_CONST char *str,
1457 ldap_dn2str LDAP_P((
1463 ldap_bv2rdn LDAP_P((
1470 ldap_str2rdn LDAP_P((
1471 LDAP_CONST char *str,
1477 ldap_rdn2bv LDAP_P((
1483 ldap_rdn2str LDAP_P((
1489 ldap_dn_normalize LDAP_P((
1490 LDAP_CONST char *in, unsigned iflags,
1491 char **out, unsigned oflags ));
1494 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1495 LDAP_CONST char *dn ));
1498 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1499 LDAP_CONST char *dn,
1503 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1504 LDAP_CONST char *rdn,
1507 typedef int LDAPDN_rewrite_func
1508 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1511 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1512 LDAPDN_rewrite_func *func, unsigned flags ));
1515 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1516 LDAP_CONST char *dn ));
1519 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1520 LDAP_CONST char *dce ));
1523 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1524 LDAP_CONST char *dn ));
1527 ldap_get_dn_ber LDAP_P((
1528 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1531 ldap_get_attribute_ber LDAP_P((
1532 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1533 struct berval **vals ));
1539 ldap_first_attribute LDAP_P((
1542 BerElement **ber ));
1545 ldap_next_attribute LDAP_P((
1554 LDAP_F( struct berval ** )
1555 ldap_get_values_len LDAP_P((
1558 LDAP_CONST char *target ));
1561 ldap_count_values_len LDAP_P((
1562 struct berval **vals ));
1565 ldap_value_free_len LDAP_P((
1566 struct berval **vals ));
1570 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1573 LDAP_CONST char *target ));
1576 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1580 ldap_value_free LDAP_P(( /* deprecated, use ldap_values_free_len */
1588 ldap_result LDAP_P((
1592 struct timeval *timeout,
1593 LDAPMessage **result ));
1596 ldap_msgtype LDAP_P((
1604 ldap_msgfree LDAP_P((
1608 ldap_msgdelete LDAP_P((
1617 ldap_bv2escaped_filter_value LDAP_P((
1619 struct berval *out ));
1622 ldap_search_ext LDAP_P((
1624 LDAP_CONST char *base,
1626 LDAP_CONST char *filter,
1629 LDAPControl **serverctrls,
1630 LDAPControl **clientctrls,
1631 struct timeval *timeout,
1636 ldap_search_ext_s LDAP_P((
1638 LDAP_CONST char *base,
1640 LDAP_CONST char *filter,
1643 LDAPControl **serverctrls,
1644 LDAPControl **clientctrls,
1645 struct timeval *timeout,
1647 LDAPMessage **res ));
1651 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1653 LDAP_CONST char *base,
1655 LDAP_CONST char *filter,
1660 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1662 LDAP_CONST char *base,
1664 LDAP_CONST char *filter,
1667 LDAPMessage **res ));
1670 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1672 LDAP_CONST char *base,
1674 LDAP_CONST char *filter,
1677 struct timeval *timeout,
1678 LDAPMessage **res ));
1685 ldap_unbind_ext LDAP_P((
1687 LDAPControl **serverctrls,
1688 LDAPControl **clientctrls));
1691 ldap_unbind_ext_s LDAP_P((
1693 LDAPControl **serverctrls,
1694 LDAPControl **clientctrls));
1698 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1702 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1710 ldap_put_vrFilter LDAP_P((
1719 ldap_memalloc LDAP_P((
1723 ldap_memrealloc LDAP_P((
1728 ldap_memcalloc LDAP_P((
1733 ldap_memfree LDAP_P((
1737 ldap_memvfree LDAP_P((
1741 ldap_strdup LDAP_P((
1742 LDAP_CONST char * ));
1745 ldap_mods_free LDAP_P((
1752 * in sort.c (deprecated, use custom code instead)
1754 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1755 LDAP_CONST char *left,
1756 LDAP_CONST char *right ));
1758 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1759 LDAP_CONST void *left,
1760 LDAP_CONST void *right ));
1762 LDAP_F( int ) /* deprecated */
1763 ldap_sort_entries LDAP_P(( LDAP *ld,
1764 LDAPMessage **chain,
1765 LDAP_CONST char *attr,
1766 LDAP_SORT_AD_CMP_PROC *cmp ));
1768 LDAP_F( int ) /* deprecated */
1769 ldap_sort_values LDAP_P((
1772 LDAP_SORT_AV_CMP_PROC *cmp ));
1774 LDAP_F( int ) /* deprecated */
1775 ldap_sort_strcasecmp LDAP_P((
1777 LDAP_CONST void *b ));
1784 ldap_is_ldap_url LDAP_P((
1785 LDAP_CONST char *url ));
1788 ldap_is_ldaps_url LDAP_P((
1789 LDAP_CONST char *url ));
1792 ldap_is_ldapi_url LDAP_P((
1793 LDAP_CONST char *url ));
1796 ldap_url_parse LDAP_P((
1797 LDAP_CONST char *url,
1798 LDAPURLDesc **ludpp ));
1801 ldap_url_desc2str LDAP_P((
1802 LDAPURLDesc *ludp ));
1805 ldap_free_urldesc LDAP_P((
1806 LDAPURLDesc *ludp ));
1810 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1813 #define LDAP_API_FEATURE_CANCEL 1000
1816 ldap_cancel LDAP_P(( LDAP *ld,
1818 LDAPControl **sctrls,
1819 LDAPControl **cctrls,
1823 ldap_cancel_s LDAP_P(( LDAP *ld,
1825 LDAPControl **sctrl,
1826 LDAPControl **cctrl ));
1829 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1832 #define LDAP_API_FEATURE_TURN 1000
1835 ldap_turn LDAP_P(( LDAP *ld,
1837 LDAP_CONST char* identifier,
1838 LDAPControl **sctrls,
1839 LDAPControl **cctrls,
1843 ldap_turn_s LDAP_P(( LDAP *ld,
1845 LDAP_CONST char* identifier,
1846 LDAPControl **sctrl,
1847 LDAPControl **cctrl ));
1850 * LDAP Paged Results
1853 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1856 ldap_create_page_control_value LDAP_P((
1859 struct berval *cookie,
1860 struct berval *value ));
1863 ldap_create_page_control LDAP_P((
1866 struct berval *cookie,
1868 LDAPControl **ctrlp ));
1872 ldap_parse_page_control LDAP_P((
1873 /* deprecated, use ldap_parse_pageresponse_control */
1875 LDAPControl **ctrls,
1877 struct berval **cookie ));
1881 ldap_parse_pageresponse_control LDAP_P((
1885 struct berval *cookie ));
1888 * LDAP Server Side Sort
1891 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1893 /* structure for a sort-key */
1894 typedef struct ldapsortkey {
1895 char *attributeType;
1901 ldap_create_sort_keylist LDAP_P((
1902 LDAPSortKey ***sortKeyList,
1906 ldap_free_sort_keylist LDAP_P((
1907 LDAPSortKey **sortkeylist ));
1910 ldap_create_sort_control_value LDAP_P((
1912 LDAPSortKey **keyList,
1913 struct berval *value ));
1916 ldap_create_sort_control LDAP_P((
1918 LDAPSortKey **keyList,
1920 LDAPControl **ctrlp ));
1923 ldap_parse_sortresponse_control LDAP_P((
1927 char **attribute ));
1930 * LDAP Virtual List View
1933 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1935 /* structure for virtual list */
1936 typedef struct ldapvlvinfo {
1937 ber_int_t ldvlv_version;
1938 ber_int_t ldvlv_before_count;
1939 ber_int_t ldvlv_after_count;
1940 ber_int_t ldvlv_offset;
1941 ber_int_t ldvlv_count;
1942 struct berval * ldvlv_attrvalue;
1943 struct berval * ldvlv_context;
1944 void * ldvlv_extradata;
1948 ldap_create_vlv_control_value LDAP_P((
1950 LDAPVLVInfo *ldvlistp,
1951 struct berval *value));
1954 ldap_create_vlv_control LDAP_P((
1956 LDAPVLVInfo *ldvlistp,
1957 LDAPControl **ctrlp ));
1960 ldap_parse_vlvresponse_control LDAP_P((
1963 ber_int_t *target_posp,
1964 ber_int_t *list_countp,
1965 struct berval **contextp,
1972 #define LDAP_API_FEATURE_WHOAMI 1000
1975 ldap_parse_whoami LDAP_P((
1978 struct berval **authzid ));
1981 ldap_whoami LDAP_P(( LDAP *ld,
1982 LDAPControl **sctrls,
1983 LDAPControl **cctrls,
1987 ldap_whoami_s LDAP_P((
1989 struct berval **authzid,
1990 LDAPControl **sctrls,
1991 LDAPControl **cctrls ));
1994 * LDAP Password Modify
1997 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2000 ldap_parse_passwd LDAP_P((
2003 struct berval *newpasswd ));
2006 ldap_passwd LDAP_P(( LDAP *ld,
2007 struct berval *user,
2008 struct berval *oldpw,
2009 struct berval *newpw,
2010 LDAPControl **sctrls,
2011 LDAPControl **cctrls,
2015 ldap_passwd_s LDAP_P((
2017 struct berval *user,
2018 struct berval *oldpw,
2019 struct berval *newpw,
2020 struct berval *newpasswd,
2021 LDAPControl **sctrls,
2022 LDAPControl **cctrls ));
2024 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2026 * LDAP Password Policy controls
2029 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2031 typedef enum passpolicyerror_enum {
2032 PP_passwordExpired = 0,
2033 PP_accountLocked = 1,
2034 PP_changeAfterReset = 2,
2035 PP_passwordModNotAllowed = 3,
2036 PP_mustSupplyOldPassword = 4,
2037 PP_insufficientPasswordQuality = 5,
2038 PP_passwordTooShort = 6,
2039 PP_passwordTooYoung = 7,
2040 PP_passwordInHistory = 8,
2042 } LDAPPasswordPolicyError;
2045 ldap_create_passwordpolicy_control LDAP_P((
2047 LDAPControl **ctrlp ));
2050 ldap_parse_passwordpolicy_control LDAP_P((
2055 LDAPPasswordPolicyError *errorp ));
2057 LDAP_F( const char * )
2058 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2059 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2062 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2065 #define LDAP_API_FEATURE_REFRESH 1000
2068 ldap_parse_refresh LDAP_P((
2071 ber_int_t *newttl ));
2074 ldap_refresh LDAP_P(( LDAP *ld,
2077 LDAPControl **sctrls,
2078 LDAPControl **cctrls,
2082 ldap_refresh_s LDAP_P((
2087 LDAPControl **sctrls,
2088 LDAPControl **cctrls ));
2095 ldap_txn_start LDAP_P(( LDAP *ld,
2096 LDAPControl **sctrls,
2097 LDAPControl **cctrls,
2101 ldap_txn_start_s LDAP_P(( LDAP *ld,
2102 LDAPControl **sctrl,
2103 LDAPControl **cctrl,
2104 struct berval **rettxnid ));
2107 ldap_txn_end LDAP_P(( LDAP *ld,
2109 struct berval *txnid,
2110 LDAPControl **sctrls,
2111 LDAPControl **cctrls,
2115 ldap_txn_end_s LDAP_P(( LDAP *ld,
2117 struct berval *txnid,
2118 LDAPControl **sctrl,
2119 LDAPControl **cctrl,
2124 #endif /* _LDAP_H */