git.sur5r.net Git - openldap/blob - include/ldap.h

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