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