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