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