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