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