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