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