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