1 /* $NetBSD: ldap.h,v 1.1.1.4 2010/12/12 15:21:23 adam Exp $ */ 2 3 /* OpenLDAP: pkg/ldap/include/ldap.h,v 1.312.2.25 2010/06/10 18:48:36 quanah Exp */ 4 /* This work is part of OpenLDAP Software <http://www.openldap.org/>. 5 * 6 * Copyright 1998-2010 The OpenLDAP Foundation. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted only as authorized by the OpenLDAP 11 * Public License. 12 * 13 * A copy of this license is available in file LICENSE in the 14 * top-level directory of the distribution or, alternatively, at 15 * <http://www.OpenLDAP.org/license.html>. 16 */ 17 /* Portions Copyright (c) 1990 Regents of the University of Michigan. 18 * All rights reserved. 19 * 20 * Redistribution and use in source and binary forms are permitted 21 * provided that this notice is preserved and that due credit is given 22 * to the University of Michigan at Ann Arbor. The name of the University 23 * may not be used to endorse or promote products derived from this 24 * software without specific prior written permission. This software 25 * is provided ``as is'' without express or implied warranty. 26 */ 27 28 #ifndef _LDAP_H 29 #define _LDAP_H 30 31 /* pull in lber */ 32 #include <lber.h> 33 34 /* include version and API feature defines */ 35 #include <ldap_features.h> 36 37 LDAP_BEGIN_DECL 38 39 #define LDAP_VERSION1 1 40 #define LDAP_VERSION2 2 41 #define LDAP_VERSION3 3 42 43 #define LDAP_VERSION_MIN LDAP_VERSION2 44 #define LDAP_VERSION LDAP_VERSION2 45 #define LDAP_VERSION_MAX LDAP_VERSION3 46 47 /* 48 * We use 3000+n here because it is above 1823 (for RFC 1823), 49 * above 2000+rev of IETF LDAPEXT draft (now quite dated), 50 * yet below allocations for new RFCs (just in case there is 51 * someday an RFC produced). 52 */ 53 #define LDAP_API_VERSION 3001 54 #define LDAP_VENDOR_NAME "OpenLDAP" 55 56 /* OpenLDAP API Features */ 57 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION 58 59 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \ 60 ( defined( LDAP_THREAD_SAFE ) && \ 61 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) ) 62 /* -lldap may or may not be thread safe */ 63 /* -lldap_r, if available, is always thread safe */ 64 # define LDAP_API_FEATURE_THREAD_SAFE 1 65 #endif 66 #if defined( LDAP_THREAD_SAFE ) && \ 67 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) 68 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */ 69 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */ 70 #endif 71 72 73 #define LDAP_PORT 389 /* ldap:/// default LDAP port */ 74 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */ 75 76 #define LDAP_ROOT_DSE "" 77 #define LDAP_NO_ATTRS "1.1" 78 #define LDAP_ALL_USER_ATTRIBUTES "*" 79 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */ 80 81 /* RFC 4511: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */ 82 #define LDAP_MAXINT (2147483647) 83 84 /* 85 * LDAP_OPTions 86 * 0x0000 - 0x0fff reserved for api options 87 * 0x1000 - 0x3fff reserved for api extended options 88 * 0x4000 - 0x7fff reserved for private and experimental options 89 */ 90 91 #define LDAP_OPT_API_INFO 0x0000 92 #define LDAP_OPT_DESC 0x0001 /* historic */ 93 #define LDAP_OPT_DEREF 0x0002 94 #define LDAP_OPT_SIZELIMIT 0x0003 95 #define LDAP_OPT_TIMELIMIT 0x0004 96 /* 0x05 - 0x07 not defined */ 97 #define LDAP_OPT_REFERRALS 0x0008 98 #define LDAP_OPT_RESTART 0x0009 99 /* 0x0a - 0x10 not defined */ 100 #define LDAP_OPT_PROTOCOL_VERSION 0x0011 101 #define LDAP_OPT_SERVER_CONTROLS 0x0012 102 #define LDAP_OPT_CLIENT_CONTROLS 0x0013 103 /* 0x14 not defined */ 104 #define LDAP_OPT_API_FEATURE_INFO 0x0015 105 /* 0x16 - 0x2f not defined */ 106 #define LDAP_OPT_HOST_NAME 0x0030 107 #define LDAP_OPT_RESULT_CODE 0x0031 108 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE 109 #define LDAP_OPT_DIAGNOSTIC_MESSAGE 0x0032 110 #define LDAP_OPT_ERROR_STRING LDAP_OPT_DIAGNOSTIC_MESSAGE 111 #define LDAP_OPT_MATCHED_DN 0x0033 112 /* 0x0034 - 0x3fff not defined */ 113 /* 0x0091 used by Microsoft for LDAP_OPT_AUTO_RECONNECT */ 114 #define LDAP_OPT_SSPI_FLAGS 0x0092 115 /* 0x0093 used by Microsoft for LDAP_OPT_SSL_INFO */ 116 /* 0x0094 used by Microsoft for LDAP_OPT_REF_DEREF_CONN_PER_MSG */ 117 #define LDAP_OPT_SIGN 0x0095 118 #define LDAP_OPT_ENCRYPT 0x0096 119 #define LDAP_OPT_SASL_METHOD 0x0097 120 /* 0x0098 used by Microsoft for LDAP_OPT_AREC_EXCLUSIVE */ 121 #define LDAP_OPT_SECURITY_CONTEXT 0x0099 122 /* 0x009A used by Microsoft for LDAP_OPT_ROOTDSE_CACHE */ 123 /* 0x009B - 0x3fff not defined */ 124 125 /* API Extensions */ 126 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */ 127 128 /* private and experimental options */ 129 /* OpenLDAP specific options */ 130 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */ 131 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */ 132 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */ 133 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */ 134 #define LDAP_OPT_URI 0x5006 135 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */ 136 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */ 137 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */ 138 #define LDAP_OPT_CONNECT_ASYNC 0x5010 /* create connections asynchronously */ 139 #define LDAP_OPT_CONNECT_CB 0x5011 /* connection callbacks */ 140 141 /* OpenLDAP TLS options */ 142 #define LDAP_OPT_X_TLS 0x6000 143 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX* */ 144 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002 145 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003 146 #define LDAP_OPT_X_TLS_CERTFILE 0x6004 147 #define LDAP_OPT_X_TLS_KEYFILE 0x6005 148 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006 149 #define LDAP_OPT_X_TLS_PROTOCOL_MIN 0x6007 150 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008 151 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009 152 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a /* OpenSSL SSL* */ 153 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b 154 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c 155 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d 156 #define LDAP_OPT_X_TLS_DHFILE 0x600e 157 #define LDAP_OPT_X_TLS_NEWCTX 0x600f 158 #define LDAP_OPT_X_TLS_CRLFILE 0x6010 /* GNUtls only */ 159 160 #define LDAP_OPT_X_TLS_NEVER 0 161 #define LDAP_OPT_X_TLS_HARD 1 162 #define LDAP_OPT_X_TLS_DEMAND 2 163 #define LDAP_OPT_X_TLS_ALLOW 3 164 #define LDAP_OPT_X_TLS_TRY 4 165 166 #define LDAP_OPT_X_TLS_CRL_NONE 0 167 #define LDAP_OPT_X_TLS_CRL_PEER 1 168 #define LDAP_OPT_X_TLS_CRL_ALL 2 169 170 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */ 171 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min)) 172 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8) 173 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8) 174 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1) 175 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2) 176 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3) 177 178 /* OpenLDAP SASL options */ 179 #define LDAP_OPT_X_SASL_MECH 0x6100 180 #define LDAP_OPT_X_SASL_REALM 0x6101 181 #define LDAP_OPT_X_SASL_AUTHCID 0x6102 182 #define LDAP_OPT_X_SASL_AUTHZID 0x6103 183 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */ 184 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */ 185 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */ 186 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107 187 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108 188 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109 189 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */ 190 #define LDAP_OPT_X_SASL_NOCANON 0x610b 191 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */ 192 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d 193 194 /* OpenLDAP GSSAPI options */ 195 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200 196 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201 197 198 /* 199 * OpenLDAP per connection tcp-keepalive settings 200 * (Linux only, ignored where unsupported) 201 */ 202 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300 203 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301 204 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302 205 206 /* Private API Extensions -- reserved for application use */ 207 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */ 208 209 /* 210 * ldap_get_option() and ldap_set_option() return values. 211 * As later versions may return other values indicating 212 * failure, current applications should only compare returned 213 * value against LDAP_OPT_SUCCESS. 214 */ 215 #define LDAP_OPT_SUCCESS 0 216 #define LDAP_OPT_ERROR (-1) 217 218 /* option on/off values */ 219 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on) 220 #define LDAP_OPT_OFF ((void *) 0) 221 222 typedef struct ldapapiinfo { 223 int ldapai_info_version; /* version of LDAPAPIInfo */ 224 #define LDAP_API_INFO_VERSION (1) 225 int ldapai_api_version; /* revision of API supported */ 226 int ldapai_protocol_version; /* highest LDAP version supported */ 227 char **ldapai_extensions; /* names of API extensions */ 228 char *ldapai_vendor_name; /* name of supplier */ 229 int ldapai_vendor_version; /* supplier-specific version * 100 */ 230 } LDAPAPIInfo; 231 232 typedef struct ldap_apifeature_info { 233 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */ 234 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */ 235 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */ 236 int ldapaif_version; /* value of LDAP_API_FEATURE_... */ 237 } LDAPAPIFeatureInfo; 238 239 /* 240 * LDAP Control structure 241 */ 242 typedef struct ldapcontrol { 243 char * ldctl_oid; /* numericoid of control */ 244 struct berval ldctl_value; /* encoded value of control */ 245 char ldctl_iscritical; /* criticality */ 246 } LDAPControl; 247 248 /* LDAP Controls */ 249 /* standard track controls */ 250 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */ 251 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */ 252 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */ 253 254 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */ 255 256 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */ 257 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */ 258 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */ 259 260 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */ 261 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */ 262 263 /* non-standard track controls */ 264 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */ 265 266 /* LDAP Content Synchronization Operation -- RFC 4533 */ 267 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1" 268 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1" 269 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2" 270 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3" 271 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4" 272 273 #define LDAP_SYNC_NONE 0x00 274 #define LDAP_SYNC_REFRESH_ONLY 0x01 275 #define LDAP_SYNC_RESERVED 0x02 276 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03 277 278 #define LDAP_SYNC_REFRESH_PRESENTS 0 279 #define LDAP_SYNC_REFRESH_DELETES 1 280 281 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U) 282 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U) 283 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U) 284 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U) 285 286 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U) 287 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U) 288 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U) 289 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U) 290 291 #define LDAP_SYNC_PRESENT 0 292 #define LDAP_SYNC_ADD 1 293 #define LDAP_SYNC_MODIFY 2 294 #define LDAP_SYNC_DELETE 3 295 #define LDAP_SYNC_NEW_COOKIE 4 296 297 298 /* Password policy Controls *//* work in progress */ 299 /* ITS#3458: released; disabled by default */ 300 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1" 301 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1" 302 303 /* various works in progress */ 304 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2" 305 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11" 306 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12" 307 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX 308 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13" 309 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14" 310 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15" 311 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16" 312 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17" 313 314 /* LDAP Chaining Behavior Control *//* work in progress */ 315 /* <draft-sermersheim-ldap-chaining>; 316 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */ 317 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3" 318 319 #define LDAP_CHAINING_PREFERRED 0 320 #define LDAP_CHAINING_REQUIRED 1 321 #define LDAP_REFERRALS_PREFERRED 2 322 #define LDAP_REFERRALS_REQUIRED 3 323 324 /* MS Active Directory controls (for compatibility) */ 325 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802" 326 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339" 327 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413" 328 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340" 329 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */ 330 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */ 331 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805" 332 333 /* MS Active Directory controls - not implemented in slapd(8) */ 334 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529" 335 336 #ifdef LDAP_DEVEL 337 /* <draft-wahl-ldap-session> */ 338 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1" 339 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \ 340 LDAP_CONTROL_X_SESSION_TRACKING ".1" 341 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \ 342 LDAP_CONTROL_X_SESSION_TRACKING ".2" 343 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \ 344 LDAP_CONTROL_X_SESSION_TRACKING ".3" 345 #endif /* LDAP_DEVEL */ 346 347 /* various expired works */ 348 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */ 349 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1" 350 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2" 351 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3" 352 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST 353 354 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */ 355 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3" 356 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7" 357 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1 358 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2 359 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4 360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8 361 362 /* LDAP VLV */ 363 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9" 364 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10" 365 366 /* LDAP Unsolicited Notifications */ 367 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */ 368 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION 369 370 /* LDAP Extended Operations */ 371 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */ 372 373 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */ 374 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U) 375 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U) 376 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U) 377 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U) 378 379 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */ 380 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL 381 382 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */ 383 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U) 384 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U) 385 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U) 386 387 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */ 388 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I 389 390 /* various works in progress */ 391 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */ 392 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN 393 394 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */ 395 /* a work in progress */ 396 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6" 397 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1" 398 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2" 399 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3" 400 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4" 401 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5" 402 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \ 403 LDAP_X_DISTPROC_BASE ".6" 404 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7" 405 #define LDAP_URLEXT_X_LOCALREF "x-localReference" 406 #define LDAP_URLEXT_X_REFTYPE "x-referenceType" 407 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree" 408 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName" 409 410 #ifdef LDAP_DEVEL 411 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */ 412 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1" 413 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2" 414 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3" 415 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4" 416 #endif 417 418 /* LDAP Features */ 419 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */ 420 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \ 421 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */ 422 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */ 423 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4" 424 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5" 425 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14" 426 427 /* LDAP Experimental (works in progress) Features */ 428 #define LDAP_FEATURE_SUBORDINATE_SCOPE \ 429 "1.3.6.1.4.1.4203.666.8.1" /* "children" */ 430 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE 431 432 /* 433 * specific LDAP instantiations of BER types we know about 434 */ 435 436 /* Overview of LBER tag construction 437 * 438 * Bits 439 * ______ 440 * 8 7 | CLASS 441 * 0 0 = UNIVERSAL 442 * 0 1 = APPLICATION 443 * 1 0 = CONTEXT-SPECIFIC 444 * 1 1 = PRIVATE 445 * _____ 446 * | 6 | DATA-TYPE 447 * 0 = PRIMITIVE 448 * 1 = CONSTRUCTED 449 * ___________ 450 * | 5 ... 1 | TAG-NUMBER 451 */ 452 453 /* general stuff */ 454 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */ 455 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */ 456 457 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */ 458 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */ 459 460 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */ 461 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */ 462 463 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */ 464 465 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */ 466 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */ 467 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */ 468 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */ 469 470 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */ 471 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */ 472 473 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */ 474 475 /* LDAP Request Messages */ 476 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */ 477 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */ 478 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */ 479 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */ 480 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */ 481 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */ 482 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */ 483 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN 484 #define LDAP_REQ_RENAME LDAP_REQ_MODDN 485 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */ 486 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */ 487 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */ 488 489 /* LDAP Response Messages */ 490 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */ 491 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */ 492 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */ 493 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */ 494 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */ 495 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */ 496 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */ 497 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */ 498 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */ 499 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */ 500 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */ 501 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */ 502 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */ 503 504 #define LDAP_RES_ANY (-1) 505 #define LDAP_RES_UNSOLICITED (0) 506 507 508 /* sasl methods */ 509 #define LDAP_SASL_SIMPLE ((char*)0) 510 #define LDAP_SASL_NULL ("") 511 512 513 /* authentication methods available */ 514 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */ 515 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */ 516 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */ 517 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */ 518 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */ 519 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */ 520 521 /* used by the Windows API but not used on the wire */ 522 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU) 523 524 /* filter types */ 525 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */ 526 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */ 527 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */ 528 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */ 529 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */ 530 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */ 531 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */ 532 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */ 533 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */ 534 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */ 535 536 /* extended filter component types */ 537 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */ 538 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */ 539 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */ 540 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */ 541 542 /* substring filter component types */ 543 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */ 544 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ 545 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */ 546 547 /* search scopes */ 548 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000) 549 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE 550 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001) 551 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL 552 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002) 553 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE 554 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */ 555 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE 556 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */ 557 558 /* substring filter component types */ 559 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */ 560 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ 561 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */ 562 563 /* 564 * LDAP Result Codes 565 */ 566 #define LDAP_SUCCESS 0x00 567 568 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y))) 569 570 #define LDAP_OPERATIONS_ERROR 0x01 571 #define LDAP_PROTOCOL_ERROR 0x02 572 #define LDAP_TIMELIMIT_EXCEEDED 0x03 573 #define LDAP_SIZELIMIT_EXCEEDED 0x04 574 #define LDAP_COMPARE_FALSE 0x05 575 #define LDAP_COMPARE_TRUE 0x06 576 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07 577 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED 578 #define LDAP_STRONG_AUTH_REQUIRED 0x08 579 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED 580 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */ 581 582 #define LDAP_REFERRAL 0x0a /* LDAPv3 */ 583 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */ 584 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */ 585 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */ 586 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */ 587 588 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */ 589 590 #define LDAP_NO_SUCH_ATTRIBUTE 0x10 591 #define LDAP_UNDEFINED_TYPE 0x11 592 #define LDAP_INAPPROPRIATE_MATCHING 0x12 593 #define LDAP_CONSTRAINT_VIOLATION 0x13 594 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14 595 #define LDAP_INVALID_SYNTAX 0x15 596 597 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */ 598 599 #define LDAP_NO_SUCH_OBJECT 0x20 600 #define LDAP_ALIAS_PROBLEM 0x21 601 #define LDAP_INVALID_DN_SYNTAX 0x22 602 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */ 603 #define LDAP_ALIAS_DEREF_PROBLEM 0x24 604 605 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */ 606 607 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */ 608 #define LDAP_INAPPROPRIATE_AUTH 0x30 609 #define LDAP_INVALID_CREDENTIALS 0x31 610 #define LDAP_INSUFFICIENT_ACCESS 0x32 611 612 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */ 613 614 #define LDAP_BUSY 0x33 615 #define LDAP_UNAVAILABLE 0x34 616 #define LDAP_UNWILLING_TO_PERFORM 0x35 617 #define LDAP_LOOP_DETECT 0x36 618 619 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */ 620 621 #define LDAP_NAMING_VIOLATION 0x40 622 #define LDAP_OBJECT_CLASS_VIOLATION 0x41 623 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42 624 #define LDAP_NOT_ALLOWED_ON_RDN 0x43 625 #define LDAP_ALREADY_EXISTS 0x44 626 #define LDAP_NO_OBJECT_CLASS_MODS 0x45 627 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */ 628 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 629 630 #define LDAP_VLV_ERROR 0x4C 631 632 #define LDAP_OTHER 0x50 633 634 /* LCUP operation codes (113-117) - not implemented */ 635 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71 636 #define LDAP_CUP_SECURITY_VIOLATION 0x72 637 #define LDAP_CUP_INVALID_DATA 0x73 638 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74 639 #define LDAP_CUP_RELOAD_REQUIRED 0x75 640 641 /* Cancel operation codes (118-121) */ 642 #define LDAP_CANCELLED 0x76 643 #define LDAP_NO_SUCH_OPERATION 0x77 644 #define LDAP_TOO_LATE 0x78 645 #define LDAP_CANNOT_CANCEL 0x79 646 647 /* Assertion control (122) */ 648 #define LDAP_ASSERTION_FAILED 0x7A 649 650 /* Proxied Authorization Denied (123) */ 651 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B 652 653 /* Experimental result codes */ 654 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) 655 656 /* LDAP Sync (4096) */ 657 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000 658 659 660 /* Private Use result codes */ 661 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) 662 663 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */ 664 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */ 665 666 /* for the LDAP No-Op control */ 667 #define LDAP_X_NO_OPERATION 0x410e 668 669 /* for the Chaining Behavior control (consecutive result codes requested; 670 * see <draft-sermersheim-ldap-chaining> ) */ 671 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR 672 #define LDAP_X_NO_REFERRALS_FOUND 0x4110 673 #define LDAP_X_CANNOT_CHAIN 0x4111 674 #endif 675 676 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */ 677 #ifdef LDAP_X_DISTPROC_BASE 678 #define LDAP_X_INVALIDREFERENCE 0x4112 679 #endif 680 681 #ifdef LDAP_X_TXN 682 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120 683 #define LDAP_X_TXN_ID_INVALID 0x4121 684 #endif 685 686 /* API Error Codes 687 * 688 * Based on draft-ietf-ldap-c-api-xx 689 * but with new negative code values 690 */ 691 #define LDAP_API_ERROR(n) ((n)<0) 692 #define LDAP_API_RESULT(n) ((n)<=0) 693 694 #define LDAP_SERVER_DOWN (-1) 695 #define LDAP_LOCAL_ERROR (-2) 696 #define LDAP_ENCODING_ERROR (-3) 697 #define LDAP_DECODING_ERROR (-4) 698 #define LDAP_TIMEOUT (-5) 699 #define LDAP_AUTH_UNKNOWN (-6) 700 #define LDAP_FILTER_ERROR (-7) 701 #define LDAP_USER_CANCELLED (-8) 702 #define LDAP_PARAM_ERROR (-9) 703 #define LDAP_NO_MEMORY (-10) 704 #define LDAP_CONNECT_ERROR (-11) 705 #define LDAP_NOT_SUPPORTED (-12) 706 #define LDAP_CONTROL_NOT_FOUND (-13) 707 #define LDAP_NO_RESULTS_RETURNED (-14) 708 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */ 709 #define LDAP_CLIENT_LOOP (-16) 710 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17) 711 #define LDAP_X_CONNECTING (-18) 712 713 714 /* 715 * This structure represents both ldap messages and ldap responses. 716 * These are really the same, except in the case of search responses, 717 * where a response has multiple messages. 718 */ 719 720 typedef struct ldapmsg LDAPMessage; 721 722 /* for modifications */ 723 typedef struct ldapmod { 724 int mod_op; 725 726 #define LDAP_MOD_OP (0x0007) 727 #define LDAP_MOD_ADD (0x0000) 728 #define LDAP_MOD_DELETE (0x0001) 729 #define LDAP_MOD_REPLACE (0x0002) 730 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */ 731 #define LDAP_MOD_BVALUES (0x0080) 732 /* IMPORTANT: do not use code 0x1000 (or above), 733 * it is used internally by the backends! 734 * (see ldap/servers/slapd/slap.h) 735 */ 736 737 char *mod_type; 738 union mod_vals_u { 739 char **modv_strvals; 740 struct berval **modv_bvals; 741 } mod_vals; 742 #define mod_values mod_vals.modv_strvals 743 #define mod_bvalues mod_vals.modv_bvals 744 } LDAPMod; 745 746 /* 747 * structure representing an ldap session which can 748 * encompass connections to multiple servers (in the 749 * face of referrals). 750 */ 751 typedef struct ldap LDAP; 752 753 #define LDAP_DEREF_NEVER 0x00 754 #define LDAP_DEREF_SEARCHING 0x01 755 #define LDAP_DEREF_FINDING 0x02 756 #define LDAP_DEREF_ALWAYS 0x03 757 758 #define LDAP_NO_LIMIT 0 759 760 /* how many messages to retrieve results for */ 761 #define LDAP_MSG_ONE 0x00 762 #define LDAP_MSG_ALL 0x01 763 #define LDAP_MSG_RECEIVED 0x02 764 765 /* 766 * types for ldap URL handling 767 */ 768 typedef struct ldap_url_desc { 769 struct ldap_url_desc *lud_next; 770 char *lud_scheme; 771 char *lud_host; 772 int lud_port; 773 char *lud_dn; 774 char **lud_attrs; 775 int lud_scope; 776 char *lud_filter; 777 char **lud_exts; 778 int lud_crit_exts; 779 } LDAPURLDesc; 780 781 #define LDAP_URL_SUCCESS 0x00 /* Success */ 782 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */ 783 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */ 784 785 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */ 786 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */ 787 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */ 788 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */ 789 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */ 790 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */ 791 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */ 792 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */ 793 794 /* 795 * LDAP sync (RFC4533) API 796 */ 797 798 typedef struct ldap_sync_t ldap_sync_t; 799 800 typedef enum { 801 /* these are private - the client should never see them */ 802 LDAP_SYNC_CAPI_NONE = -1, 803 804 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U, 805 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U, 806 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U, 807 808 /* these are passed to ls_search_entry() */ 809 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT, 810 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD, 811 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY, 812 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE, 813 814 /* these are passed to ls_intermediate() */ 815 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ), 816 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ), 817 818 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ), 819 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ), 820 821 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS ) 822 } ldap_sync_refresh_t; 823 824 /* 825 * Called when an entry is returned by ldap_result(). 826 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY, 827 * the entry has been either added or modified, and thus 828 * the complete view of the entry should be in the LDAPMessage. 829 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE, 830 * only the DN should be in the LDAPMessage. 831 */ 832 typedef int (*ldap_sync_search_entry_f) LDAP_P(( 833 ldap_sync_t *ls, 834 LDAPMessage *msg, 835 struct berval *entryUUID, 836 ldap_sync_refresh_t phase )); 837 838 /* 839 * Called when a reference is returned; the client should know 840 * what to do with it. 841 */ 842 typedef int (*ldap_sync_search_reference_f) LDAP_P(( 843 ldap_sync_t *ls, 844 LDAPMessage *msg )); 845 846 /* 847 * Called when specific intermediate/final messages are returned. 848 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES, 849 * a "presents" or "deletes" phase begins. 850 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase 851 * with refreshDone set to "TRUE" has been returned, to indicate 852 * that the refresh phase of a refreshAndPersist is complete. 853 * In the above cases, syncUUIDs is NULL. 854 * 855 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or 856 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs 857 * that are either present or have been deleted. 858 */ 859 typedef int (*ldap_sync_intermediate_f) LDAP_P(( 860 ldap_sync_t *ls, 861 LDAPMessage *msg, 862 BerVarray syncUUIDs, 863 ldap_sync_refresh_t phase )); 864 865 /* 866 * Called when a searchResultDone is returned. In refreshAndPersist, 867 * this can only occur if the search for any reason is being terminated 868 * by the server. 869 */ 870 typedef int (*ldap_sync_search_result_f) LDAP_P(( 871 ldap_sync_t *ls, 872 LDAPMessage *msg, 873 int refreshDeletes )); 874 875 /* 876 * This structure contains all information about the persistent search; 877 * the caller is responsible for connecting, setting version, binding, tls... 878 */ 879 struct ldap_sync_t { 880 /* conf search params */ 881 char *ls_base; 882 int ls_scope; 883 char *ls_filter; 884 char **ls_attrs; 885 int ls_timelimit; 886 int ls_sizelimit; 887 888 /* poll timeout */ 889 int ls_timeout; 890 891 /* helpers - add as appropriate */ 892 ldap_sync_search_entry_f ls_search_entry; 893 ldap_sync_search_reference_f ls_search_reference; 894 ldap_sync_intermediate_f ls_intermediate; 895 ldap_sync_search_result_f ls_search_result; 896 897 /* set by the caller as appropriate */ 898 void *ls_private; 899 900 /* conn stuff */ 901 LDAP *ls_ld; 902 903 /* --- the parameters below are private - do not modify --- */ 904 905 /* FIXME: make the structure opaque, and provide an interface 906 * to modify the public values? */ 907 908 /* result stuff */ 909 int ls_msgid; 910 911 /* sync stuff */ 912 /* needed by refreshOnly */ 913 int ls_reloadHint; 914 915 /* opaque - need to pass between sessions, updated by the API */ 916 struct berval ls_cookie; 917 918 /* state variable - do not modify */ 919 ldap_sync_refresh_t ls_refreshPhase; 920 }; 921 922 /* 923 * End of LDAP sync (RFC4533) API 924 */ 925 926 /* 927 * Connection callbacks... 928 */ 929 struct ldap_conncb; 930 struct sockaddr; 931 932 /* Called after a connection is established */ 933 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr, 934 struct ldap_conncb *ctx )); 935 /* Called before a connection is closed */ 936 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx )); 937 938 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The 939 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle. 940 */ 941 typedef struct ldap_conncb { 942 ldap_conn_add_f *lc_add; 943 ldap_conn_del_f *lc_del; 944 void *lc_arg; 945 } ldap_conncb; 946 947 /* 948 * The API draft spec says we should declare (or cause to be declared) 949 * 'struct timeval'. We don't. See IETF LDAPext discussions. 950 */ 951 struct timeval; 952 953 /* 954 * in options.c: 955 */ 956 LDAP_F( int ) 957 ldap_get_option LDAP_P(( 958 LDAP *ld, 959 int option, 960 void *outvalue)); 961 962 LDAP_F( int ) 963 ldap_set_option LDAP_P(( 964 LDAP *ld, 965 int option, 966 LDAP_CONST void *invalue)); 967 968 /* V3 REBIND Function Callback Prototype */ 969 typedef int (LDAP_REBIND_PROC) LDAP_P(( 970 LDAP *ld, LDAP_CONST char *url, 971 ber_tag_t request, ber_int_t msgid, 972 void *params )); 973 974 LDAP_F( int ) 975 ldap_set_rebind_proc LDAP_P(( 976 LDAP *ld, 977 LDAP_REBIND_PROC *rebind_proc, 978 void *params )); 979 980 /* V3 referral selection Function Callback Prototype */ 981 typedef int (LDAP_NEXTREF_PROC) LDAP_P(( 982 LDAP *ld, char ***refsp, int *cntp, 983 void *params )); 984 985 LDAP_F( int ) 986 ldap_set_nextref_proc LDAP_P(( 987 LDAP *ld, 988 LDAP_NEXTREF_PROC *nextref_proc, 989 void *params )); 990 991 /* V3 URLLIST Function Callback Prototype */ 992 typedef int (LDAP_URLLIST_PROC) LDAP_P(( 993 LDAP *ld, 994 LDAPURLDesc **urllist, 995 LDAPURLDesc **url, 996 void *params )); 997 998 LDAP_F( int ) 999 ldap_set_urllist_proc LDAP_P(( 1000 LDAP *ld, 1001 LDAP_URLLIST_PROC *urllist_proc, 1002 void *params )); 1003 1004 /* 1005 * in controls.c: 1006 */ 1007 #if LDAP_DEPRECATED 1008 LDAP_F( int ) 1009 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */ 1010 LDAP_CONST char *requestOID, 1011 BerElement *ber, 1012 int iscritical, 1013 LDAPControl **ctrlp )); 1014 1015 LDAP_F( LDAPControl * ) 1016 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */ 1017 LDAP_CONST char *oid, 1018 LDAPControl **ctrls )); 1019 #endif 1020 1021 LDAP_F( int ) 1022 ldap_control_create LDAP_P(( 1023 LDAP_CONST char *requestOID, 1024 int iscritical, 1025 struct berval *value, 1026 int dupval, 1027 LDAPControl **ctrlp )); 1028 1029 LDAP_F( LDAPControl * ) 1030 ldap_control_find LDAP_P(( 1031 LDAP_CONST char *oid, 1032 LDAPControl **ctrls, 1033 LDAPControl ***nextctrlp )); 1034 1035 LDAP_F( void ) 1036 ldap_control_free LDAP_P(( 1037 LDAPControl *ctrl )); 1038 1039 LDAP_F( void ) 1040 ldap_controls_free LDAP_P(( 1041 LDAPControl **ctrls )); 1042 1043 LDAP_F( LDAPControl ** ) 1044 ldap_controls_dup LDAP_P(( 1045 LDAPControl *LDAP_CONST *controls )); 1046 1047 LDAP_F( LDAPControl * ) 1048 ldap_control_dup LDAP_P(( 1049 LDAP_CONST LDAPControl *c )); 1050 1051 /* 1052 * in dnssrv.c: 1053 */ 1054 LDAP_F( int ) 1055 ldap_domain2dn LDAP_P(( 1056 LDAP_CONST char* domain, 1057 char** dn )); 1058 1059 LDAP_F( int ) 1060 ldap_dn2domain LDAP_P(( 1061 LDAP_CONST char* dn, 1062 char** domain )); 1063 1064 LDAP_F( int ) 1065 ldap_domain2hostlist LDAP_P(( 1066 LDAP_CONST char *domain, 1067 char** hostlist )); 1068 1069 /* 1070 * in extended.c: 1071 */ 1072 LDAP_F( int ) 1073 ldap_extended_operation LDAP_P(( 1074 LDAP *ld, 1075 LDAP_CONST char *reqoid, 1076 struct berval *reqdata, 1077 LDAPControl **serverctrls, 1078 LDAPControl **clientctrls, 1079 int *msgidp )); 1080 1081 LDAP_F( int ) 1082 ldap_extended_operation_s LDAP_P(( 1083 LDAP *ld, 1084 LDAP_CONST char *reqoid, 1085 struct berval *reqdata, 1086 LDAPControl **serverctrls, 1087 LDAPControl **clientctrls, 1088 char **retoidp, 1089 struct berval **retdatap )); 1090 1091 LDAP_F( int ) 1092 ldap_parse_extended_result LDAP_P(( 1093 LDAP *ld, 1094 LDAPMessage *res, 1095 char **retoidp, 1096 struct berval **retdatap, 1097 int freeit )); 1098 1099 LDAP_F( int ) 1100 ldap_parse_intermediate LDAP_P(( 1101 LDAP *ld, 1102 LDAPMessage *res, 1103 char **retoidp, 1104 struct berval **retdatap, 1105 LDAPControl ***serverctrls, 1106 int freeit )); 1107 1108 1109 /* 1110 * in abandon.c: 1111 */ 1112 LDAP_F( int ) 1113 ldap_abandon_ext LDAP_P(( 1114 LDAP *ld, 1115 int msgid, 1116 LDAPControl **serverctrls, 1117 LDAPControl **clientctrls )); 1118 1119 #if LDAP_DEPRECATED 1120 LDAP_F( int ) 1121 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */ 1122 LDAP *ld, 1123 int msgid )); 1124 #endif 1125 1126 /* 1127 * in add.c: 1128 */ 1129 LDAP_F( int ) 1130 ldap_add_ext LDAP_P(( 1131 LDAP *ld, 1132 LDAP_CONST char *dn, 1133 LDAPMod **attrs, 1134 LDAPControl **serverctrls, 1135 LDAPControl **clientctrls, 1136 int *msgidp )); 1137 1138 LDAP_F( int ) 1139 ldap_add_ext_s LDAP_P(( 1140 LDAP *ld, 1141 LDAP_CONST char *dn, 1142 LDAPMod **attrs, 1143 LDAPControl **serverctrls, 1144 LDAPControl **clientctrls )); 1145 1146 #if LDAP_DEPRECATED 1147 LDAP_F( int ) 1148 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */ 1149 LDAP *ld, 1150 LDAP_CONST char *dn, 1151 LDAPMod **attrs )); 1152 1153 LDAP_F( int ) 1154 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */ 1155 LDAP *ld, 1156 LDAP_CONST char *dn, 1157 LDAPMod **attrs )); 1158 #endif 1159 1160 1161 /* 1162 * in sasl.c: 1163 */ 1164 LDAP_F( int ) 1165 ldap_sasl_bind LDAP_P(( 1166 LDAP *ld, 1167 LDAP_CONST char *dn, 1168 LDAP_CONST char *mechanism, 1169 struct berval *cred, 1170 LDAPControl **serverctrls, 1171 LDAPControl **clientctrls, 1172 int *msgidp )); 1173 1174 /* Interaction flags (should be passed about in a control) 1175 * Automatic (default): use defaults, prompt otherwise 1176 * Interactive: prompt always 1177 * Quiet: never prompt 1178 */ 1179 #define LDAP_SASL_AUTOMATIC 0U 1180 #define LDAP_SASL_INTERACTIVE 1U 1181 #define LDAP_SASL_QUIET 2U 1182 1183 /* 1184 * V3 SASL Interaction Function Callback Prototype 1185 * when using Cyrus SASL, interact is pointer to sasl_interact_t 1186 * should likely passed in a control (and provided controls) 1187 */ 1188 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P(( 1189 LDAP *ld, unsigned flags, void* defaults, void *interact )); 1190 1191 LDAP_F( int ) 1192 ldap_sasl_interactive_bind_s LDAP_P(( 1193 LDAP *ld, 1194 LDAP_CONST char *dn, /* usually NULL */ 1195 LDAP_CONST char *saslMechanism, 1196 LDAPControl **serverControls, 1197 LDAPControl **clientControls, 1198 1199 /* should be client controls */ 1200 unsigned flags, 1201 LDAP_SASL_INTERACT_PROC *proc, 1202 void *defaults )); 1203 1204 LDAP_F( int ) 1205 ldap_sasl_bind_s LDAP_P(( 1206 LDAP *ld, 1207 LDAP_CONST char *dn, 1208 LDAP_CONST char *mechanism, 1209 struct berval *cred, 1210 LDAPControl **serverctrls, 1211 LDAPControl **clientctrls, 1212 struct berval **servercredp )); 1213 1214 LDAP_F( int ) 1215 ldap_parse_sasl_bind_result LDAP_P(( 1216 LDAP *ld, 1217 LDAPMessage *res, 1218 struct berval **servercredp, 1219 int freeit )); 1220 1221 #if LDAP_DEPRECATED 1222 /* 1223 * in bind.c: 1224 * (deprecated) 1225 */ 1226 LDAP_F( int ) 1227 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */ 1228 LDAP *ld, 1229 LDAP_CONST char *who, 1230 LDAP_CONST char *passwd, 1231 int authmethod )); 1232 1233 LDAP_F( int ) 1234 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */ 1235 LDAP *ld, 1236 LDAP_CONST char *who, 1237 LDAP_CONST char *cred, 1238 int authmethod )); 1239 1240 /* 1241 * in sbind.c: 1242 */ 1243 LDAP_F( int ) 1244 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */ 1245 LDAP *ld, 1246 LDAP_CONST char *who, 1247 LDAP_CONST char *passwd )); 1248 1249 LDAP_F( int ) 1250 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */ 1251 LDAP *ld, 1252 LDAP_CONST char *who, 1253 LDAP_CONST char *passwd )); 1254 1255 #endif 1256 1257 1258 /* 1259 * in compare.c: 1260 */ 1261 LDAP_F( int ) 1262 ldap_compare_ext LDAP_P(( 1263 LDAP *ld, 1264 LDAP_CONST char *dn, 1265 LDAP_CONST char *attr, 1266 struct berval *bvalue, 1267 LDAPControl **serverctrls, 1268 LDAPControl **clientctrls, 1269 int *msgidp )); 1270 1271 LDAP_F( int ) 1272 ldap_compare_ext_s LDAP_P(( 1273 LDAP *ld, 1274 LDAP_CONST char *dn, 1275 LDAP_CONST char *attr, 1276 struct berval *bvalue, 1277 LDAPControl **serverctrls, 1278 LDAPControl **clientctrls )); 1279 1280 #if LDAP_DEPRECATED 1281 LDAP_F( int ) 1282 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */ 1283 LDAP *ld, 1284 LDAP_CONST char *dn, 1285 LDAP_CONST char *attr, 1286 LDAP_CONST char *value )); 1287 1288 LDAP_F( int ) 1289 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */ 1290 LDAP *ld, 1291 LDAP_CONST char *dn, 1292 LDAP_CONST char *attr, 1293 LDAP_CONST char *value )); 1294 #endif 1295 1296 1297 /* 1298 * in delete.c: 1299 */ 1300 LDAP_F( int ) 1301 ldap_delete_ext LDAP_P(( 1302 LDAP *ld, 1303 LDAP_CONST char *dn, 1304 LDAPControl **serverctrls, 1305 LDAPControl **clientctrls, 1306 int *msgidp )); 1307 1308 LDAP_F( int ) 1309 ldap_delete_ext_s LDAP_P(( 1310 LDAP *ld, 1311 LDAP_CONST char *dn, 1312 LDAPControl **serverctrls, 1313 LDAPControl **clientctrls )); 1314 1315 #if LDAP_DEPRECATED 1316 LDAP_F( int ) 1317 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */ 1318 LDAP *ld, 1319 LDAP_CONST char *dn )); 1320 1321 LDAP_F( int ) 1322 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */ 1323 LDAP *ld, 1324 LDAP_CONST char *dn )); 1325 #endif 1326 1327 1328 /* 1329 * in error.c: 1330 */ 1331 LDAP_F( int ) 1332 ldap_parse_result LDAP_P(( 1333 LDAP *ld, 1334 LDAPMessage *res, 1335 int *errcodep, 1336 char **matcheddnp, 1337 char **errmsgp, 1338 char ***referralsp, 1339 LDAPControl ***serverctrls, 1340 int freeit )); 1341 1342 LDAP_F( char * ) 1343 ldap_err2string LDAP_P(( 1344 int err )); 1345 1346 #if LDAP_DEPRECATED 1347 LDAP_F( int ) 1348 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */ 1349 LDAP *ld, 1350 LDAPMessage *r, 1351 int freeit )); 1352 1353 LDAP_F( void ) 1354 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */ 1355 LDAP *ld, 1356 LDAP_CONST char *s )); 1357 #endif 1358 1359 1360 /* 1361 * gssapi.c: 1362 */ 1363 LDAP_F( int ) 1364 ldap_gssapi_bind LDAP_P(( 1365 LDAP *ld, 1366 LDAP_CONST char *dn, 1367 LDAP_CONST char *creds )); 1368 1369 LDAP_F( int ) 1370 ldap_gssapi_bind_s LDAP_P(( 1371 LDAP *ld, 1372 LDAP_CONST char *dn, 1373 LDAP_CONST char *creds )); 1374 1375 1376 /* 1377 * in modify.c: 1378 */ 1379 LDAP_F( int ) 1380 ldap_modify_ext LDAP_P(( 1381 LDAP *ld, 1382 LDAP_CONST char *dn, 1383 LDAPMod **mods, 1384 LDAPControl **serverctrls, 1385 LDAPControl **clientctrls, 1386 int *msgidp )); 1387 1388 LDAP_F( int ) 1389 ldap_modify_ext_s LDAP_P(( 1390 LDAP *ld, 1391 LDAP_CONST char *dn, 1392 LDAPMod **mods, 1393 LDAPControl **serverctrls, 1394 LDAPControl **clientctrls )); 1395 1396 #if LDAP_DEPRECATED 1397 LDAP_F( int ) 1398 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */ 1399 LDAP *ld, 1400 LDAP_CONST char *dn, 1401 LDAPMod **mods )); 1402 1403 LDAP_F( int ) 1404 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */ 1405 LDAP *ld, 1406 LDAP_CONST char *dn, 1407 LDAPMod **mods )); 1408 #endif 1409 1410 1411 /* 1412 * in modrdn.c: 1413 */ 1414 LDAP_F( int ) 1415 ldap_rename LDAP_P(( 1416 LDAP *ld, 1417 LDAP_CONST char *dn, 1418 LDAP_CONST char *newrdn, 1419 LDAP_CONST char *newSuperior, 1420 int deleteoldrdn, 1421 LDAPControl **sctrls, 1422 LDAPControl **cctrls, 1423 int *msgidp )); 1424 1425 LDAP_F( int ) 1426 ldap_rename_s LDAP_P(( 1427 LDAP *ld, 1428 LDAP_CONST char *dn, 1429 LDAP_CONST char *newrdn, 1430 LDAP_CONST char *newSuperior, 1431 int deleteoldrdn, 1432 LDAPControl **sctrls, 1433 LDAPControl **cctrls )); 1434 1435 #if LDAP_DEPRECATED 1436 LDAP_F( int ) 1437 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */ 1438 LDAP *ld, 1439 LDAP_CONST char *dn, 1440 LDAP_CONST char *newrdn, 1441 LDAP_CONST char *newSuperior, 1442 int deleteoldrdn )); 1443 1444 LDAP_F( int ) 1445 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */ 1446 LDAP *ld, 1447 LDAP_CONST char *dn, 1448 LDAP_CONST char *newrdn, 1449 LDAP_CONST char *newSuperior, 1450 int deleteoldrdn )); 1451 1452 LDAP_F( int ) 1453 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */ 1454 LDAP *ld, 1455 LDAP_CONST char *dn, 1456 LDAP_CONST char *newrdn )); 1457 1458 LDAP_F( int ) 1459 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */ 1460 LDAP *ld, 1461 LDAP_CONST char *dn, 1462 LDAP_CONST char *newrdn )); 1463 1464 LDAP_F( int ) 1465 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */ 1466 LDAP *ld, 1467 LDAP_CONST char *dn, 1468 LDAP_CONST char *newrdn, 1469 int deleteoldrdn )); 1470 1471 LDAP_F( int ) 1472 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */ 1473 LDAP *ld, 1474 LDAP_CONST char *dn, 1475 LDAP_CONST char *newrdn, 1476 int deleteoldrdn)); 1477 #endif 1478 1479 1480 /* 1481 * in open.c: 1482 */ 1483 #if LDAP_DEPRECATED 1484 LDAP_F( LDAP * ) 1485 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */ 1486 LDAP_CONST char *host, 1487 int port )); 1488 1489 LDAP_F( LDAP * ) 1490 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */ 1491 LDAP_CONST char *host, 1492 int port )); 1493 #endif 1494 1495 LDAP_F( int ) 1496 ldap_create LDAP_P(( 1497 LDAP **ldp )); 1498 1499 LDAP_F( int ) 1500 ldap_initialize LDAP_P(( 1501 LDAP **ldp, 1502 LDAP_CONST char *url )); 1503 1504 /* 1505 * in tls.c 1506 */ 1507 1508 LDAP_F( int ) 1509 ldap_tls_inplace LDAP_P(( 1510 LDAP *ld )); 1511 1512 LDAP_F( int ) 1513 ldap_start_tls LDAP_P(( 1514 LDAP *ld, 1515 LDAPControl **serverctrls, 1516 LDAPControl **clientctrls, 1517 int *msgidp )); 1518 1519 LDAP_F( int ) 1520 ldap_install_tls LDAP_P(( 1521 LDAP *ld )); 1522 1523 LDAP_F( int ) 1524 ldap_start_tls_s LDAP_P(( 1525 LDAP *ld, 1526 LDAPControl **serverctrls, 1527 LDAPControl **clientctrls )); 1528 1529 /* 1530 * in messages.c: 1531 */ 1532 LDAP_F( LDAPMessage * ) 1533 ldap_first_message LDAP_P(( 1534 LDAP *ld, 1535 LDAPMessage *chain )); 1536 1537 LDAP_F( LDAPMessage * ) 1538 ldap_next_message LDAP_P(( 1539 LDAP *ld, 1540 LDAPMessage *msg )); 1541 1542 LDAP_F( int ) 1543 ldap_count_messages LDAP_P(( 1544 LDAP *ld, 1545 LDAPMessage *chain )); 1546 1547 /* 1548 * in references.c: 1549 */ 1550 LDAP_F( LDAPMessage * ) 1551 ldap_first_reference LDAP_P(( 1552 LDAP *ld, 1553 LDAPMessage *chain )); 1554 1555 LDAP_F( LDAPMessage * ) 1556 ldap_next_reference LDAP_P(( 1557 LDAP *ld, 1558 LDAPMessage *ref )); 1559 1560 LDAP_F( int ) 1561 ldap_count_references LDAP_P(( 1562 LDAP *ld, 1563 LDAPMessage *chain )); 1564 1565 LDAP_F( int ) 1566 ldap_parse_reference LDAP_P(( 1567 LDAP *ld, 1568 LDAPMessage *ref, 1569 char ***referralsp, 1570 LDAPControl ***serverctrls, 1571 int freeit)); 1572 1573 1574 /* 1575 * in getentry.c: 1576 */ 1577 LDAP_F( LDAPMessage * ) 1578 ldap_first_entry LDAP_P(( 1579 LDAP *ld, 1580 LDAPMessage *chain )); 1581 1582 LDAP_F( LDAPMessage * ) 1583 ldap_next_entry LDAP_P(( 1584 LDAP *ld, 1585 LDAPMessage *entry )); 1586 1587 LDAP_F( int ) 1588 ldap_count_entries LDAP_P(( 1589 LDAP *ld, 1590 LDAPMessage *chain )); 1591 1592 LDAP_F( int ) 1593 ldap_get_entry_controls LDAP_P(( 1594 LDAP *ld, 1595 LDAPMessage *entry, 1596 LDAPControl ***serverctrls)); 1597 1598 1599 /* 1600 * in addentry.c 1601 */ 1602 LDAP_F( LDAPMessage * ) 1603 ldap_delete_result_entry LDAP_P(( 1604 LDAPMessage **list, 1605 LDAPMessage *e )); 1606 1607 LDAP_F( void ) 1608 ldap_add_result_entry LDAP_P(( 1609 LDAPMessage **list, 1610 LDAPMessage *e )); 1611 1612 1613 /* 1614 * in getdn.c 1615 */ 1616 LDAP_F( char * ) 1617 ldap_get_dn LDAP_P(( 1618 LDAP *ld, 1619 LDAPMessage *entry )); 1620 1621 typedef struct ldap_ava { 1622 struct berval la_attr; 1623 struct berval la_value; 1624 unsigned la_flags; 1625 #define LDAP_AVA_NULL 0x0000U 1626 #define LDAP_AVA_STRING 0x0001U 1627 #define LDAP_AVA_BINARY 0x0002U 1628 #define LDAP_AVA_NONPRINTABLE 0x0004U 1629 #define LDAP_AVA_FREE_ATTR 0x0010U 1630 #define LDAP_AVA_FREE_VALUE 0x0020U 1631 1632 void *la_private; 1633 } LDAPAVA; 1634 1635 typedef LDAPAVA** LDAPRDN; 1636 typedef LDAPRDN* LDAPDN; 1637 1638 /* DN formats */ 1639 #define LDAP_DN_FORMAT_LDAP 0x0000U 1640 #define LDAP_DN_FORMAT_LDAPV3 0x0010U 1641 #define LDAP_DN_FORMAT_LDAPV2 0x0020U 1642 #define LDAP_DN_FORMAT_DCE 0x0030U 1643 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */ 1644 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */ 1645 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */ 1646 #define LDAP_DN_FORMAT_MASK 0x00F0U 1647 1648 /* DN flags */ 1649 #define LDAP_DN_PRETTY 0x0100U 1650 #define LDAP_DN_SKIP 0x0200U 1651 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U 1652 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U 1653 #define LDAP_DN_PEDANTIC 0xF000U 1654 1655 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn )); 1656 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn )); 1657 1658 LDAP_F( int ) 1659 ldap_bv2dn LDAP_P(( 1660 struct berval *bv, 1661 LDAPDN *dn, 1662 unsigned flags )); 1663 1664 LDAP_F( int ) 1665 ldap_str2dn LDAP_P(( 1666 LDAP_CONST char *str, 1667 LDAPDN *dn, 1668 unsigned flags )); 1669 1670 LDAP_F( int ) 1671 ldap_dn2bv LDAP_P(( 1672 LDAPDN dn, 1673 struct berval *bv, 1674 unsigned flags )); 1675 1676 LDAP_F( int ) 1677 ldap_dn2str LDAP_P(( 1678 LDAPDN dn, 1679 char **str, 1680 unsigned flags )); 1681 1682 LDAP_F( int ) 1683 ldap_bv2rdn LDAP_P(( 1684 struct berval *bv, 1685 LDAPRDN *rdn, 1686 char **next, 1687 unsigned flags )); 1688 1689 LDAP_F( int ) 1690 ldap_str2rdn LDAP_P(( 1691 LDAP_CONST char *str, 1692 LDAPRDN *rdn, 1693 char **next, 1694 unsigned flags )); 1695 1696 LDAP_F( int ) 1697 ldap_rdn2bv LDAP_P(( 1698 LDAPRDN rdn, 1699 struct berval *bv, 1700 unsigned flags )); 1701 1702 LDAP_F( int ) 1703 ldap_rdn2str LDAP_P(( 1704 LDAPRDN rdn, 1705 char **str, 1706 unsigned flags )); 1707 1708 LDAP_F( int ) 1709 ldap_dn_normalize LDAP_P(( 1710 LDAP_CONST char *in, unsigned iflags, 1711 char **out, unsigned oflags )); 1712 1713 LDAP_F( char * ) 1714 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */ 1715 LDAP_CONST char *dn )); 1716 1717 LDAP_F( char ** ) 1718 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */ 1719 LDAP_CONST char *dn, 1720 int notypes )); 1721 1722 LDAP_F( char ** ) 1723 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */ 1724 LDAP_CONST char *rdn, 1725 int notypes )); 1726 1727 typedef int LDAPDN_rewrite_func 1728 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx )); 1729 1730 LDAP_F( int ) 1731 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn, 1732 LDAPDN_rewrite_func *func, unsigned flags )); 1733 1734 LDAP_F( char * ) 1735 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */ 1736 LDAP_CONST char *dn )); 1737 1738 LDAP_F( char * ) 1739 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */ 1740 LDAP_CONST char *dce )); 1741 1742 LDAP_F( char * ) 1743 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */ 1744 LDAP_CONST char *dn )); 1745 1746 LDAP_F( int ) 1747 ldap_get_dn_ber LDAP_P(( 1748 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn )); 1749 1750 LDAP_F( int ) 1751 ldap_get_attribute_ber LDAP_P(( 1752 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr, 1753 struct berval **vals )); 1754 1755 /* 1756 * in getattr.c 1757 */ 1758 LDAP_F( char * ) 1759 ldap_first_attribute LDAP_P(( 1760 LDAP *ld, 1761 LDAPMessage *entry, 1762 BerElement **ber )); 1763 1764 LDAP_F( char * ) 1765 ldap_next_attribute LDAP_P(( 1766 LDAP *ld, 1767 LDAPMessage *entry, 1768 BerElement *ber )); 1769 1770 1771 /* 1772 * in getvalues.c 1773 */ 1774 LDAP_F( struct berval ** ) 1775 ldap_get_values_len LDAP_P(( 1776 LDAP *ld, 1777 LDAPMessage *entry, 1778 LDAP_CONST char *target )); 1779 1780 LDAP_F( int ) 1781 ldap_count_values_len LDAP_P(( 1782 struct berval **vals )); 1783 1784 LDAP_F( void ) 1785 ldap_value_free_len LDAP_P(( 1786 struct berval **vals )); 1787 1788 #if LDAP_DEPRECATED 1789 LDAP_F( char ** ) 1790 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */ 1791 LDAP *ld, 1792 LDAPMessage *entry, 1793 LDAP_CONST char *target )); 1794 1795 LDAP_F( int ) 1796 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */ 1797 char **vals )); 1798 1799 LDAP_F( void ) 1800 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */ 1801 char **vals )); 1802 #endif 1803 1804 /* 1805 * in result.c: 1806 */ 1807 LDAP_F( int ) 1808 ldap_result LDAP_P(( 1809 LDAP *ld, 1810 int msgid, 1811 int all, 1812 struct timeval *timeout, 1813 LDAPMessage **result )); 1814 1815 LDAP_F( int ) 1816 ldap_msgtype LDAP_P(( 1817 LDAPMessage *lm )); 1818 1819 LDAP_F( int ) 1820 ldap_msgid LDAP_P(( 1821 LDAPMessage *lm )); 1822 1823 LDAP_F( int ) 1824 ldap_msgfree LDAP_P(( 1825 LDAPMessage *lm )); 1826 1827 LDAP_F( int ) 1828 ldap_msgdelete LDAP_P(( 1829 LDAP *ld, 1830 int msgid )); 1831 1832 1833 /* 1834 * in search.c: 1835 */ 1836 LDAP_F( int ) 1837 ldap_bv2escaped_filter_value LDAP_P(( 1838 struct berval *in, 1839 struct berval *out )); 1840 1841 LDAP_F( int ) 1842 ldap_search_ext LDAP_P(( 1843 LDAP *ld, 1844 LDAP_CONST char *base, 1845 int scope, 1846 LDAP_CONST char *filter, 1847 char **attrs, 1848 int attrsonly, 1849 LDAPControl **serverctrls, 1850 LDAPControl **clientctrls, 1851 struct timeval *timeout, 1852 int sizelimit, 1853 int *msgidp )); 1854 1855 LDAP_F( int ) 1856 ldap_search_ext_s LDAP_P(( 1857 LDAP *ld, 1858 LDAP_CONST char *base, 1859 int scope, 1860 LDAP_CONST char *filter, 1861 char **attrs, 1862 int attrsonly, 1863 LDAPControl **serverctrls, 1864 LDAPControl **clientctrls, 1865 struct timeval *timeout, 1866 int sizelimit, 1867 LDAPMessage **res )); 1868 1869 #if LDAP_DEPRECATED 1870 LDAP_F( int ) 1871 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */ 1872 LDAP *ld, 1873 LDAP_CONST char *base, 1874 int scope, 1875 LDAP_CONST char *filter, 1876 char **attrs, 1877 int attrsonly )); 1878 1879 LDAP_F( int ) 1880 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */ 1881 LDAP *ld, 1882 LDAP_CONST char *base, 1883 int scope, 1884 LDAP_CONST char *filter, 1885 char **attrs, 1886 int attrsonly, 1887 LDAPMessage **res )); 1888 1889 LDAP_F( int ) 1890 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */ 1891 LDAP *ld, 1892 LDAP_CONST char *base, 1893 int scope, 1894 LDAP_CONST char *filter, 1895 char **attrs, 1896 int attrsonly, 1897 struct timeval *timeout, 1898 LDAPMessage **res )); 1899 #endif 1900 1901 /* 1902 * in unbind.c 1903 */ 1904 LDAP_F( int ) 1905 ldap_unbind_ext LDAP_P(( 1906 LDAP *ld, 1907 LDAPControl **serverctrls, 1908 LDAPControl **clientctrls)); 1909 1910 LDAP_F( int ) 1911 ldap_unbind_ext_s LDAP_P(( 1912 LDAP *ld, 1913 LDAPControl **serverctrls, 1914 LDAPControl **clientctrls)); 1915 1916 #if LDAP_DEPRECATED 1917 LDAP_F( int ) 1918 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */ 1919 LDAP *ld )); 1920 1921 LDAP_F( int ) 1922 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */ 1923 LDAP *ld )); 1924 #endif 1925 1926 /* 1927 * in filter.c 1928 */ 1929 LDAP_F( int ) 1930 ldap_put_vrFilter LDAP_P(( 1931 BerElement *ber, 1932 const char *vrf )); 1933 1934 /* 1935 * in free.c 1936 */ 1937 1938 LDAP_F( void * ) 1939 ldap_memalloc LDAP_P(( 1940 ber_len_t s )); 1941 1942 LDAP_F( void * ) 1943 ldap_memrealloc LDAP_P(( 1944 void* p, 1945 ber_len_t s )); 1946 1947 LDAP_F( void * ) 1948 ldap_memcalloc LDAP_P(( 1949 ber_len_t n, 1950 ber_len_t s )); 1951 1952 LDAP_F( void ) 1953 ldap_memfree LDAP_P(( 1954 void* p )); 1955 1956 LDAP_F( void ) 1957 ldap_memvfree LDAP_P(( 1958 void** v )); 1959 1960 LDAP_F( char * ) 1961 ldap_strdup LDAP_P(( 1962 LDAP_CONST char * )); 1963 1964 LDAP_F( void ) 1965 ldap_mods_free LDAP_P(( 1966 LDAPMod **mods, 1967 int freemods )); 1968 1969 1970 #if LDAP_DEPRECATED 1971 /* 1972 * in sort.c (deprecated, use custom code instead) 1973 */ 1974 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */ 1975 LDAP_CONST char *left, 1976 LDAP_CONST char *right )); 1977 1978 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */ 1979 LDAP_CONST void *left, 1980 LDAP_CONST void *right )); 1981 1982 LDAP_F( int ) /* deprecated */ 1983 ldap_sort_entries LDAP_P(( LDAP *ld, 1984 LDAPMessage **chain, 1985 LDAP_CONST char *attr, 1986 LDAP_SORT_AD_CMP_PROC *cmp )); 1987 1988 LDAP_F( int ) /* deprecated */ 1989 ldap_sort_values LDAP_P(( 1990 LDAP *ld, 1991 char **vals, 1992 LDAP_SORT_AV_CMP_PROC *cmp )); 1993 1994 LDAP_F( int ) /* deprecated */ 1995 ldap_sort_strcasecmp LDAP_P(( 1996 LDAP_CONST void *a, 1997 LDAP_CONST void *b )); 1998 #endif 1999 2000 /* 2001 * in url.c 2002 */ 2003 LDAP_F( int ) 2004 ldap_is_ldap_url LDAP_P(( 2005 LDAP_CONST char *url )); 2006 2007 LDAP_F( int ) 2008 ldap_is_ldaps_url LDAP_P(( 2009 LDAP_CONST char *url )); 2010 2011 LDAP_F( int ) 2012 ldap_is_ldapi_url LDAP_P(( 2013 LDAP_CONST char *url )); 2014 2015 LDAP_F( int ) 2016 ldap_url_parse LDAP_P(( 2017 LDAP_CONST char *url, 2018 LDAPURLDesc **ludpp )); 2019 2020 LDAP_F( char * ) 2021 ldap_url_desc2str LDAP_P(( 2022 LDAPURLDesc *ludp )); 2023 2024 LDAP_F( void ) 2025 ldap_free_urldesc LDAP_P(( 2026 LDAPURLDesc *ludp )); 2027 2028 2029 /* 2030 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt> 2031 * in cancel.c 2032 */ 2033 #define LDAP_API_FEATURE_CANCEL 1000 2034 2035 LDAP_F( int ) 2036 ldap_cancel LDAP_P(( LDAP *ld, 2037 int cancelid, 2038 LDAPControl **sctrls, 2039 LDAPControl **cctrls, 2040 int *msgidp )); 2041 2042 LDAP_F( int ) 2043 ldap_cancel_s LDAP_P(( LDAP *ld, 2044 int cancelid, 2045 LDAPControl **sctrl, 2046 LDAPControl **cctrl )); 2047 2048 /* 2049 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt> 2050 * in turn.c 2051 */ 2052 #define LDAP_API_FEATURE_TURN 1000 2053 2054 LDAP_F( int ) 2055 ldap_turn LDAP_P(( LDAP *ld, 2056 int mutual, 2057 LDAP_CONST char* identifier, 2058 LDAPControl **sctrls, 2059 LDAPControl **cctrls, 2060 int *msgidp )); 2061 2062 LDAP_F( int ) 2063 ldap_turn_s LDAP_P(( LDAP *ld, 2064 int mutual, 2065 LDAP_CONST char* identifier, 2066 LDAPControl **sctrl, 2067 LDAPControl **cctrl )); 2068 2069 /* 2070 * LDAP Paged Results 2071 * in pagectrl.c 2072 */ 2073 #define LDAP_API_FEATURE_PAGED_RESULTS 2000 2074 2075 LDAP_F( int ) 2076 ldap_create_page_control_value LDAP_P(( 2077 LDAP *ld, 2078 ber_int_t pagesize, 2079 struct berval *cookie, 2080 struct berval *value )); 2081 2082 LDAP_F( int ) 2083 ldap_create_page_control LDAP_P(( 2084 LDAP *ld, 2085 ber_int_t pagesize, 2086 struct berval *cookie, 2087 int iscritical, 2088 LDAPControl **ctrlp )); 2089 2090 #if LDAP_DEPRECATED 2091 LDAP_F( int ) 2092 ldap_parse_page_control LDAP_P(( 2093 /* deprecated, use ldap_parse_pageresponse_control */ 2094 LDAP *ld, 2095 LDAPControl **ctrls, 2096 ber_int_t *count, 2097 struct berval **cookie )); 2098 #endif 2099 2100 LDAP_F( int ) 2101 ldap_parse_pageresponse_control LDAP_P(( 2102 LDAP *ld, 2103 LDAPControl *ctrl, 2104 ber_int_t *count, 2105 struct berval *cookie )); 2106 2107 /* 2108 * LDAP Server Side Sort 2109 * in sortctrl.c 2110 */ 2111 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000 2112 2113 /* structure for a sort-key */ 2114 typedef struct ldapsortkey { 2115 char *attributeType; 2116 char *orderingRule; 2117 int reverseOrder; 2118 } LDAPSortKey; 2119 2120 LDAP_F( int ) 2121 ldap_create_sort_keylist LDAP_P(( 2122 LDAPSortKey ***sortKeyList, 2123 char *keyString )); 2124 2125 LDAP_F( void ) 2126 ldap_free_sort_keylist LDAP_P(( 2127 LDAPSortKey **sortkeylist )); 2128 2129 LDAP_F( int ) 2130 ldap_create_sort_control_value LDAP_P(( 2131 LDAP *ld, 2132 LDAPSortKey **keyList, 2133 struct berval *value )); 2134 2135 LDAP_F( int ) 2136 ldap_create_sort_control LDAP_P(( 2137 LDAP *ld, 2138 LDAPSortKey **keyList, 2139 int iscritical, 2140 LDAPControl **ctrlp )); 2141 2142 LDAP_F( int ) 2143 ldap_parse_sortresponse_control LDAP_P(( 2144 LDAP *ld, 2145 LDAPControl *ctrl, 2146 ber_int_t *result, 2147 char **attribute )); 2148 2149 /* 2150 * LDAP Virtual List View 2151 * in vlvctrl.c 2152 */ 2153 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000 2154 2155 /* structure for virtual list */ 2156 typedef struct ldapvlvinfo { 2157 ber_int_t ldvlv_version; 2158 ber_int_t ldvlv_before_count; 2159 ber_int_t ldvlv_after_count; 2160 ber_int_t ldvlv_offset; 2161 ber_int_t ldvlv_count; 2162 struct berval * ldvlv_attrvalue; 2163 struct berval * ldvlv_context; 2164 void * ldvlv_extradata; 2165 } LDAPVLVInfo; 2166 2167 LDAP_F( int ) 2168 ldap_create_vlv_control_value LDAP_P(( 2169 LDAP *ld, 2170 LDAPVLVInfo *ldvlistp, 2171 struct berval *value)); 2172 2173 LDAP_F( int ) 2174 ldap_create_vlv_control LDAP_P(( 2175 LDAP *ld, 2176 LDAPVLVInfo *ldvlistp, 2177 LDAPControl **ctrlp )); 2178 2179 LDAP_F( int ) 2180 ldap_parse_vlvresponse_control LDAP_P(( 2181 LDAP *ld, 2182 LDAPControl *ctrls, 2183 ber_int_t *target_posp, 2184 ber_int_t *list_countp, 2185 struct berval **contextp, 2186 int *errcodep )); 2187 2188 /* 2189 * LDAP Who Am I? 2190 * in whoami.c 2191 */ 2192 #define LDAP_API_FEATURE_WHOAMI 1000 2193 2194 LDAP_F( int ) 2195 ldap_parse_whoami LDAP_P(( 2196 LDAP *ld, 2197 LDAPMessage *res, 2198 struct berval **authzid )); 2199 2200 LDAP_F( int ) 2201 ldap_whoami LDAP_P(( LDAP *ld, 2202 LDAPControl **sctrls, 2203 LDAPControl **cctrls, 2204 int *msgidp )); 2205 2206 LDAP_F( int ) 2207 ldap_whoami_s LDAP_P(( 2208 LDAP *ld, 2209 struct berval **authzid, 2210 LDAPControl **sctrls, 2211 LDAPControl **cctrls )); 2212 2213 /* 2214 * LDAP Password Modify 2215 * in passwd.c 2216 */ 2217 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000 2218 2219 LDAP_F( int ) 2220 ldap_parse_passwd LDAP_P(( 2221 LDAP *ld, 2222 LDAPMessage *res, 2223 struct berval *newpasswd )); 2224 2225 LDAP_F( int ) 2226 ldap_passwd LDAP_P(( LDAP *ld, 2227 struct berval *user, 2228 struct berval *oldpw, 2229 struct berval *newpw, 2230 LDAPControl **sctrls, 2231 LDAPControl **cctrls, 2232 int *msgidp )); 2233 2234 LDAP_F( int ) 2235 ldap_passwd_s LDAP_P(( 2236 LDAP *ld, 2237 struct berval *user, 2238 struct berval *oldpw, 2239 struct berval *newpw, 2240 struct berval *newpasswd, 2241 LDAPControl **sctrls, 2242 LDAPControl **cctrls )); 2243 2244 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST 2245 /* 2246 * LDAP Password Policy controls 2247 * in ppolicy.c 2248 */ 2249 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000 2250 2251 typedef enum passpolicyerror_enum { 2252 PP_passwordExpired = 0, 2253 PP_accountLocked = 1, 2254 PP_changeAfterReset = 2, 2255 PP_passwordModNotAllowed = 3, 2256 PP_mustSupplyOldPassword = 4, 2257 PP_insufficientPasswordQuality = 5, 2258 PP_passwordTooShort = 6, 2259 PP_passwordTooYoung = 7, 2260 PP_passwordInHistory = 8, 2261 PP_noError = 65535 2262 } LDAPPasswordPolicyError; 2263 2264 LDAP_F( int ) 2265 ldap_create_passwordpolicy_control LDAP_P(( 2266 LDAP *ld, 2267 LDAPControl **ctrlp )); 2268 2269 LDAP_F( int ) 2270 ldap_parse_passwordpolicy_control LDAP_P(( 2271 LDAP *ld, 2272 LDAPControl *ctrl, 2273 ber_int_t *expirep, 2274 ber_int_t *gracep, 2275 LDAPPasswordPolicyError *errorp )); 2276 2277 LDAP_F( const char * ) 2278 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError )); 2279 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */ 2280 2281 /* 2282 * LDAP Dynamic Directory Services Refresh -- RFC 2589 2283 * in dds.c 2284 */ 2285 #define LDAP_API_FEATURE_REFRESH 1000 2286 2287 LDAP_F( int ) 2288 ldap_parse_refresh LDAP_P(( 2289 LDAP *ld, 2290 LDAPMessage *res, 2291 ber_int_t *newttl )); 2292 2293 LDAP_F( int ) 2294 ldap_refresh LDAP_P(( LDAP *ld, 2295 struct berval *dn, 2296 ber_int_t ttl, 2297 LDAPControl **sctrls, 2298 LDAPControl **cctrls, 2299 int *msgidp )); 2300 2301 LDAP_F( int ) 2302 ldap_refresh_s LDAP_P(( 2303 LDAP *ld, 2304 struct berval *dn, 2305 ber_int_t ttl, 2306 ber_int_t *newttl, 2307 LDAPControl **sctrls, 2308 LDAPControl **cctrls )); 2309 2310 /* 2311 * LDAP Transactions 2312 */ 2313 #ifdef LDAP_X_TXN 2314 LDAP_F( int ) 2315 ldap_txn_start LDAP_P(( LDAP *ld, 2316 LDAPControl **sctrls, 2317 LDAPControl **cctrls, 2318 int *msgidp )); 2319 2320 LDAP_F( int ) 2321 ldap_txn_start_s LDAP_P(( LDAP *ld, 2322 LDAPControl **sctrl, 2323 LDAPControl **cctrl, 2324 struct berval **rettxnid )); 2325 2326 LDAP_F( int ) 2327 ldap_txn_end LDAP_P(( LDAP *ld, 2328 int commit, 2329 struct berval *txnid, 2330 LDAPControl **sctrls, 2331 LDAPControl **cctrls, 2332 int *msgidp )); 2333 2334 LDAP_F( int ) 2335 ldap_txn_end_s LDAP_P(( LDAP *ld, 2336 int commit, 2337 struct berval *txnid, 2338 LDAPControl **sctrl, 2339 LDAPControl **cctrl, 2340 int *retidp )); 2341 #endif 2342 2343 /* 2344 * in ldap_sync.c 2345 */ 2346 2347 /* 2348 * initialize the persistent search structure 2349 */ 2350 LDAP_F( ldap_sync_t * ) 2351 ldap_sync_initialize LDAP_P(( 2352 ldap_sync_t *ls )); 2353 2354 /* 2355 * destroy the persistent search structure 2356 */ 2357 LDAP_F( void ) 2358 ldap_sync_destroy LDAP_P(( 2359 ldap_sync_t *ls, 2360 int freeit )); 2361 2362 /* 2363 * initialize a refreshOnly sync 2364 */ 2365 LDAP_F( int ) 2366 ldap_sync_init LDAP_P(( 2367 ldap_sync_t *ls, 2368 int mode )); 2369 2370 /* 2371 * initialize a refreshOnly sync 2372 */ 2373 LDAP_F( int ) 2374 ldap_sync_init_refresh_only LDAP_P(( 2375 ldap_sync_t *ls )); 2376 2377 /* 2378 * initialize a refreshAndPersist sync 2379 */ 2380 LDAP_F( int ) 2381 ldap_sync_init_refresh_and_persist LDAP_P(( 2382 ldap_sync_t *ls )); 2383 2384 /* 2385 * poll for new responses 2386 */ 2387 LDAP_F( int ) 2388 ldap_sync_poll LDAP_P(( 2389 ldap_sync_t *ls )); 2390 2391 #ifdef LDAP_CONTROL_X_SESSION_TRACKING 2392 2393 /* 2394 * in stctrl.c 2395 */ 2396 LDAP_F( int ) 2397 ldap_create_session_tracking_value LDAP_P(( 2398 LDAP *ld, 2399 char *sessionSourceIp, 2400 char *sessionSourceName, 2401 char *formatOID, 2402 struct berval *sessionTrackingIdentifier, 2403 struct berval *value )); 2404 2405 LDAP_F( int ) 2406 ldap_create_session_tracking LDAP_P(( 2407 LDAP *ld, 2408 char *sessionSourceIp, 2409 char *sessionSourceName, 2410 char *formatOID, 2411 struct berval *sessionTrackingIdentifier, 2412 LDAPControl **ctrlp )); 2413 2414 LDAP_F( int ) 2415 ldap_parse_session_tracking_control LDAP_P(( 2416 LDAP *ld, 2417 LDAPControl *ctrl, 2418 struct berval *ip, 2419 struct berval *name, 2420 struct berval *oid, 2421 struct berval *id )); 2422 2423 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */ 2424 2425 /* 2426 * in assertion.c 2427 */ 2428 LDAP_F (int) 2429 ldap_create_assertion_control_value LDAP_P(( 2430 LDAP *ld, 2431 char *assertion, 2432 struct berval *value )); 2433 2434 LDAP_F( int ) 2435 ldap_create_assertion_control LDAP_P(( 2436 LDAP *ld, 2437 char *filter, 2438 int iscritical, 2439 LDAPControl **ctrlp )); 2440 2441 /* 2442 * in deref.c 2443 */ 2444 2445 typedef struct LDAPDerefSpec { 2446 char *derefAttr; 2447 char **attributes; 2448 } LDAPDerefSpec; 2449 2450 typedef struct LDAPDerefVal { 2451 char *type; 2452 BerVarray vals; 2453 struct LDAPDerefVal *next; 2454 } LDAPDerefVal; 2455 2456 typedef struct LDAPDerefRes { 2457 char *derefAttr; 2458 struct berval derefVal; 2459 LDAPDerefVal *attrVals; 2460 struct LDAPDerefRes *next; 2461 } LDAPDerefRes; 2462 2463 LDAP_F( int ) 2464 ldap_create_deref_control_value LDAP_P(( 2465 LDAP *ld, 2466 LDAPDerefSpec *ds, 2467 struct berval *value )); 2468 2469 LDAP_F( int ) 2470 ldap_create_deref_control LDAP_P(( 2471 LDAP *ld, 2472 LDAPDerefSpec *ds, 2473 int iscritical, 2474 LDAPControl **ctrlp )); 2475 2476 LDAP_F( void ) 2477 ldap_derefresponse_free LDAP_P(( 2478 LDAPDerefRes *dr )); 2479 2480 LDAP_F( int ) 2481 ldap_parse_derefresponse_control LDAP_P(( 2482 LDAP *ld, 2483 LDAPControl *ctrl, 2484 LDAPDerefRes **drp )); 2485 2486 LDAP_F( int ) 2487 ldap_parse_deref_control LDAP_P(( 2488 LDAP *ld, 2489 LDAPControl **ctrls, 2490 LDAPDerefRes **drp )); 2491 2492 LDAP_END_DECL 2493 #endif /* _LDAP_H */ 2494