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 /* Use -DLDAP_DEPRECATED=0 to hide deprecated interfaces */
  46 #ifndef LDAP_DEPRECATED
  47 #define LDAP_DEPRECATED 1
  48 #endif
  49
  50 /*
  51  * We use 3000+n here because it is above 1823 (for RFC 1823),
  52  * above 2000+rev of IETF LDAPEXT draft (now quite dated),
  53  * yet below allocations for new RFCs (just in case there is
  54  * someday an RFC produced).
  55  */
  56 #define LDAP_API_VERSION        3001
  57 #define LDAP_VENDOR_NAME        "OpenLDAP"
  58
  59 /* OpenLDAP API Features */
  60 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  61
  62 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  63         ( defined( LDAP_THREAD_SAFE ) && \
  64                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  65         /* -lldap may or may not be thread safe */
  66         /* -lldap_r, if available, is always thread safe */
  67 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  68 #endif
  69 #if defined( LDAP_THREAD_SAFE ) && \
  70         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  71 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  72 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  73 #endif
  74
  75
  76 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  77 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  78
  79 #define LDAP_ROOT_DSE                           ""
  80 #define LDAP_NO_ATTRS                           "1.1"
  81 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  82 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
  83
  84 /* RFC 2251:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
  85 #define LDAP_MAXINT (2147483647)
  86
  87 /*
  88  * LDAP_OPTions
  89  *      0x0000 - 0x0fff reserved for api options
  90  *      0x1000 - 0x3fff reserved for api extended options
  91  *      0x4000 - 0x7fff reserved for private and experimental options
  92  */
  93
  94 #define LDAP_OPT_API_INFO                       0x0000
  95 #define LDAP_OPT_DESC                           0x0001 /* historic */
  96 #define LDAP_OPT_DEREF                          0x0002
  97 #define LDAP_OPT_SIZELIMIT                      0x0003
  98 #define LDAP_OPT_TIMELIMIT                      0x0004
  99 /* 0x05 - 0x07 not defined */
 100 #define LDAP_OPT_REFERRALS                      0x0008
 101 #define LDAP_OPT_RESTART                        0x0009
 102 /* 0x0a - 0x10 not defined */
 103 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
 104 #define LDAP_OPT_SERVER_CONTROLS        0x0012
 105 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
 106 /* 0x14 not defined */
 107 #define LDAP_OPT_API_FEATURE_INFO       0x0015
 108 /* 0x16 - 0x2f not defined */
 109 #define LDAP_OPT_HOST_NAME                      0x0030
 110 #define LDAP_OPT_RESULT_CODE            0x0031
 111 #define LDAP_OPT_ERROR_NUMBER           LDAP_OPT_RESULT_CODE
 112 #define LDAP_OPT_ERROR_STRING           0x0032
 113 #define LDAP_OPT_MATCHED_DN                     0x0033
 114 /* 0x0034 - 0x3fff not defined */
 115
 116 /* API Extensions */
 117 #define LDAP_OPT_API_EXTENSION_BASE 0x4000  /* API extensions */
 118
 119 /* private and experimental options */
 120 /* OpenLDAP specific options */
 121 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 122 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 123 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 124 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 125 #define LDAP_OPT_URI                            0x5006
 126 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 127
 128 /* OpenLDAP TLS options */
 129 #define LDAP_OPT_X_TLS                          0x6000
 130 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 131 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 132 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 133 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 134 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 135 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 136 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 137 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 138 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 139 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 140
 141 #define LDAP_OPT_X_TLS_NEVER    0
 142 #define LDAP_OPT_X_TLS_HARD             1
 143 #define LDAP_OPT_X_TLS_DEMAND   2
 144 #define LDAP_OPT_X_TLS_ALLOW    3
 145 #define LDAP_OPT_X_TLS_TRY              4
 146
 147 /* OpenLDAP SASL options */
 148 #define LDAP_OPT_X_SASL_MECH                    0x6100
 149 #define LDAP_OPT_X_SASL_REALM                   0x6101
 150 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 151 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 152 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 153 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 154 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 155 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 156 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 157 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 158
 159 /* Private API Extensions -- reserved for application use */
 160 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000  /* Private API inclusive */
 161
 162 /*
 163  * ldap_get_option() and ldap_set_option() return values.
 164  * As later versions may return other values indicating
 165  * failure, current applications should only compare returned
 166  * value against LDAP_OPT_SUCCESS.
 167  */
 168 #define LDAP_OPT_SUCCESS        0
 169 #define LDAP_OPT_ERROR          (-1)
 170
 171 /* option on/off values */
 172 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
 173 #define LDAP_OPT_OFF    ((void *) 0)
 174
 175 typedef struct ldapapiinfo {
 176         int             ldapai_info_version;            /* version of LDAPAPIInfo */
 177 #define LDAP_API_INFO_VERSION   (1)
 178         int             ldapai_api_version;                     /* revision of API supported */
 179         int             ldapai_protocol_version;        /* highest LDAP version supported */
 180         char    **ldapai_extensions;            /* names of API extensions */
 181         char    *ldapai_vendor_name;            /* name of supplier */
 182         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 183 } LDAPAPIInfo;
 184
 185 typedef struct ldap_apifeature_info {
 186         int             ldapaif_info_version;           /* version of LDAPAPIFeatureInfo */
 187 #define LDAP_FEATURE_INFO_VERSION (1)   /* apifeature_info struct version */
 188         char*   ldapaif_name;                           /* LDAP_API_FEATURE_* (less prefix) */
 189         int             ldapaif_version;                        /* value of LDAP_API_FEATURE_... */
 190 } LDAPAPIFeatureInfo;
 191
 192 /*
 193  * LDAP Control structure
 194  */
 195 typedef struct ldapcontrol {
 196         char *                  ldctl_oid;                      /* numericoid of control */
 197         struct berval   ldctl_value;            /* encoded value of control */
 198         char                    ldctl_iscritical;       /* criticality */
 199 } LDAPControl;
 200
 201 /* LDAP Controls */
 202 /*      standard track controls */
 203 #define LDAP_CONTROL_MANAGEDSAIT                "2.16.840.1.113730.3.4.2" /* RFC 3296 */
 204 #define LDAP_CONTROL_SUBENTRIES                 "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
 205 #define LDAP_CONTROL_PAGEDRESULTS               "1.2.840.113556.1.4.319"  /* RFC 2696 */
 206
 207 /*  standard track - not implemented in slapd(8) */
 208 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
 209 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
 210
 211 /* but not yet formalized controls */
 212 #define LDAP_CONTROL_PROXY_AUTHZ                "2.16.840.1.113730.3.4.18"
 213 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
 214
 215 /* various works in progress */
 216 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.4.1.4203.666.5.9"
 217 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
 218 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.4.1.4203.666.5.10.1"
 219 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.4.1.4203.666.5.10.2"
 220
 221 /* LDAP VLV *//* not implemented in slapd(8) */
 222 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 223 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 224
 225 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
 226 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
 227 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
 228 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
 229 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
 230 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
 231
 232 #define LDAP_SYNC_NONE                                  0x00
 233 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 234 #define LDAP_SYNC_RESERVED                              0x02
 235 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 236
 237 #define LDAP_SYNC_REFRESH_PRESENTS              0
 238 #define LDAP_SYNC_REFRESH_DELETES               1
 239
 240 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 241 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 242 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 243 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 244
 245 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 246 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 247 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 248 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 249
 250 #define LDAP_SYNC_PRESENT                               0
 251 #define LDAP_SYNC_ADD                                   1
 252 #define LDAP_SYNC_MODIFY                                2
 253 #define LDAP_SYNC_DELETE                                3
 254
 255 /* MS ActiveDirectory controls (for compatibility) */
 256 #define LDAP_CONTROL_X_DOMAIN_SCOPE             "1.2.840.113556.1.4.1339"
 257 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
 258
 259 /* LDAP Unsolicited Notifications */
 260 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
 261 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 262
 263 /* LDAP Extended Operations */
 264 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
 265
 266 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 267 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 268 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 269 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 270 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 271
 272 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
 273 #define LDAP_EXOP_X_CANCEL              "1.3.6.1.4.1.4203.666.6.3"
 274
 275 /* LDAP Features */
 276 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
 277 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
 278         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
 279 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 280 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 281 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 282 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
 283
 284 /*
 285  * specific LDAP instantiations of BER types we know about
 286  */
 287
 288 /* Overview of LBER tag construction
 289  *
 290  *      Bits
 291  *      ______
 292  *      8 7 | CLASS
 293  *      0 0 = UNIVERSAL
 294  *      0 1 = APPLICATION
 295  *      1 0 = CONTEXT-SPECIFIC
 296  *      1 1 = PRIVATE
 297  *              _____
 298  *              | 6 | DATA-TYPE
 299  *                0 = PRIMITIVE
 300  *                1 = CONSTRUCTED
 301  *                      ___________
 302  *                      | 5 ... 1 | TAG-NUMBER
 303  */
 304
 305 /* general stuff */
 306 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 307 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 308
 309 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 310 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 311
 312 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 313 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 314
 315 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 316
 317 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 318 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 319 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 320 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 321
 322 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 323
 324 /* LDAP Request Messages */
 325 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
 326 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
 327 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
 328 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
 329 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
 330 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
 331 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
 332 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
 333 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
 334 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
 335 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
 336 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
 337
 338 /* LDAP Response Messages */
 339 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
 340 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
 341 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 342 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
 343 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
 344 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
 345 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
 346 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
 347 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
 348 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
 349 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
 350 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 351 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
 352
 353 #define LDAP_RES_ANY                    (-1)
 354 #define LDAP_RES_UNSOLICITED    (0)
 355
 356
 357 /* sasl methods */
 358 #define LDAP_SASL_SIMPLE        ((char*)0)
 359 #define LDAP_SASL_NULL          ("")
 360
 361
 362 /* authentication methods available */
 363 #define LDAP_AUTH_NONE   ((ber_tag_t) 0x00U) /* no authentication */
 364 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
 365 #define LDAP_AUTH_SASL   ((ber_tag_t) 0xa3U) /* context specific + constructed */
 366 #define LDAP_AUTH_KRBV4  ((ber_tag_t) 0xffU) /* means do both of the following */
 367 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
 368 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
 369
 370
 371 /* filter types */
 372 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 373 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 374 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 375 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
 376 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
 377 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
 378 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
 379 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive   */
 380 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U)  /* context specific + constructed */
 381 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 382
 383 /* extended filter component types */
 384 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
 385 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 386 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 387 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 388
 389 /* substring filter component types */
 390 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 391 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 392 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 393
 394 /* search scopes */
 395 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
 396 #define LDAP_SCOPE_BASE                 ((ber_int_t) 0x0000)
 397 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
 398 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
 399 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
 400 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
 401 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
 402
 403 /* substring filter component types */
 404 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 405 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 406 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 407
 408 /*
 409  * LDAP Result Codes
 410  */
 411 #define LDAP_SUCCESS                            0x00
 412
 413 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 414
 415 #define LDAP_OPERATIONS_ERROR           0x01
 416 #define LDAP_PROTOCOL_ERROR                     0x02
 417 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 418 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 419 #define LDAP_COMPARE_FALSE                      0x05
 420 #define LDAP_COMPARE_TRUE                       0x06
 421 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 422 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 423 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 424 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 425
 426 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 427 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 428 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 429 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 430 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 431
 432 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 433
 434 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 435 #define LDAP_UNDEFINED_TYPE                     0x11
 436 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 437 #define LDAP_CONSTRAINT_VIOLATION       0x13
 438 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 439 #define LDAP_INVALID_SYNTAX                     0x15
 440
 441 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 442
 443 #define LDAP_NO_SUCH_OBJECT                     0x20
 444 #define LDAP_ALIAS_PROBLEM                      0x21
 445 #define LDAP_INVALID_DN_SYNTAX          0x22
 446 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
 447 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 448
 449 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 450
 451 #define LDAP_PROXY_AUTHZ_FAILURE        0x2F /* LDAPv3 proxy authorization */
 452 #define LDAP_INAPPROPRIATE_AUTH         0x30
 453 #define LDAP_INVALID_CREDENTIALS        0x31
 454 #define LDAP_INSUFFICIENT_ACCESS        0x32
 455
 456 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 457
 458 #define LDAP_BUSY                                       0x33
 459 #define LDAP_UNAVAILABLE                        0x34
 460 #define LDAP_UNWILLING_TO_PERFORM       0x35
 461 #define LDAP_LOOP_DETECT                        0x36
 462
 463 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 464
 465 #define LDAP_NAMING_VIOLATION           0x40
 466 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 467 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 468 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 469 #define LDAP_ALREADY_EXISTS                     0x44
 470 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 471 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 472 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 473
 474 #define LDAP_OTHER                              0x50
 475
 476 /* Experimental result codes */
 477 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
 478 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
 479
 480 /* for the LDAP Sync operation */
 481 #define LDAP_SYNC_REFRESH_REQUIRED              0x4100
 482
 483 /* for the LDAP No-Op control */
 484 #define LDAP_NO_OPERATION                               0x410e
 485
 486 /* for the Assertion control */
 487 #define LDAP_ASSERTION_FAILED                   0x410f
 488
 489 /* for the Cancel operation */
 490 #define LDAP_CANCELLED                                  0x4110
 491 #define LDAP_NO_SUCH_OPERATION                  0x4111
 492 #define LDAP_TOO_LATE                                   0x4112
 493 #define LDAP_CANNOT_CANCEL                              0x4113
 494
 495 /* API Error Codes
 496  *
 497  * Based on draft-ietf-ldap-c-api-xx
 498  * but with new negative code values
 499  */
 500 #define LDAP_API_ERROR(n)               ((n)<0)
 501 #define LDAP_API_RESULT(n)              ((n)<=0)
 502
 503 #define LDAP_SERVER_DOWN                                (-1)
 504 #define LDAP_LOCAL_ERROR                                (-2)
 505 #define LDAP_ENCODING_ERROR                             (-3)
 506 #define LDAP_DECODING_ERROR                             (-4)
 507 #define LDAP_TIMEOUT                                    (-5)
 508 #define LDAP_AUTH_UNKNOWN                               (-6)
 509 #define LDAP_FILTER_ERROR                               (-7)
 510 #define LDAP_USER_CANCELLED                             (-8)
 511 #define LDAP_PARAM_ERROR                                (-9)
 512 #define LDAP_NO_MEMORY                                  (-10)
 513 #define LDAP_CONNECT_ERROR                              (-11)
 514 #define LDAP_NOT_SUPPORTED                              (-12)
 515 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 516 #define LDAP_NO_RESULTS_RETURNED                (-14)
 517 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)
 518 #define LDAP_CLIENT_LOOP                                (-16)
 519 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 520
 521
 522 /*
 523  * This structure represents both ldap messages and ldap responses.
 524  * These are really the same, except in the case of search responses,
 525  * where a response has multiple messages.
 526  */
 527
 528 typedef struct ldapmsg LDAPMessage;
 529
 530 /* for modifications */
 531 typedef struct ldapmod {
 532         int             mod_op;
 533
 534 #define LDAP_MOD_OP                     (0x0007)
 535 #define LDAP_MOD_ADD            (0x0000)
 536 #define LDAP_MOD_DELETE         (0x0001)
 537 #define LDAP_MOD_REPLACE        (0x0002)
 538 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 539 #define LDAP_MOD_BVALUES        (0x0080)
 540 /* IMPORTANT: do not use code 0x1000 (or above),
 541  * it is used internally by the backends!
 542  * (see ldap/servers/slapd/slap.h)
 543  */
 544
 545         char            *mod_type;
 546         union mod_vals_u {
 547                 char            **modv_strvals;
 548                 struct berval   **modv_bvals;
 549         } mod_vals;
 550 #define mod_values      mod_vals.modv_strvals
 551 #define mod_bvalues     mod_vals.modv_bvals
 552 } LDAPMod;
 553
 554 /*
 555  * structure representing an ldap session which can
 556  * encompass connections to multiple servers (in the
 557  * face of referrals).
 558  */
 559 typedef struct ldap LDAP;
 560
 561 #define LDAP_DEREF_NEVER                0x00
 562 #define LDAP_DEREF_SEARCHING    0x01
 563 #define LDAP_DEREF_FINDING              0x02
 564 #define LDAP_DEREF_ALWAYS               0x03
 565
 566 #define LDAP_NO_LIMIT                   0
 567
 568 /* how many messages to retrieve results for */
 569 #define LDAP_MSG_ONE                    0x00
 570 #define LDAP_MSG_ALL                    0x01
 571 #define LDAP_MSG_RECEIVED               0x02
 572
 573 /*
 574  * types for ldap URL handling
 575  */
 576 typedef struct ldap_url_desc {
 577         struct ldap_url_desc *lud_next;
 578         char    *lud_scheme;
 579         char    *lud_host;
 580         int             lud_port;
 581         char    *lud_dn;
 582         char    **lud_attrs;
 583         int             lud_scope;
 584         char    *lud_filter;
 585         char    **lud_exts;
 586         int             lud_crit_exts;
 587 } LDAPURLDesc;
 588
 589 #define LDAP_URL_SUCCESS                0x00    /* Success */
 590 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 591 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 592
 593 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 594 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 595 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 596 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 597 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 598 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 599 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 600 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 601
 602 /*
 603  * The API draft spec says we should declare (or cause to be declared)
 604  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 605  */
 606 struct timeval;
 607
 608 /*
 609  * in options.c:
 610  */
 611 LDAP_F( int )
 612 ldap_get_option LDAP_P((
 613         LDAP *ld,
 614         int option,
 615         void *outvalue));
 616
 617 LDAP_F( int )
 618 ldap_set_option LDAP_P((
 619         LDAP *ld,
 620         int option,
 621         LDAP_CONST void *invalue));
 622
 623 /* V3 REBIND Function Callback Prototype */
 624 typedef int (LDAP_REBIND_PROC) LDAP_P((
 625         LDAP *ld, LDAP_CONST char *url,
 626         ber_tag_t request, ber_int_t msgid,
 627         void *params ));
 628
 629 LDAP_F( int )
 630 ldap_set_rebind_proc LDAP_P((
 631         LDAP *ld,
 632         LDAP_REBIND_PROC *rebind_proc,
 633         void *params ));
 634
 635 /*
 636  * in controls.c:
 637  */
 638 LDAP_F( int )
 639 ldap_create_control LDAP_P((
 640         LDAP_CONST char *requestOID,
 641         BerElement *ber,
 642         int iscritical,
 643         LDAPControl **ctrlp ));
 644
 645 LDAP_F( LDAPControl * )
 646 ldap_find_control LDAP_P((
 647         LDAP_CONST char *oid,
 648         LDAPControl **ctrls ));
 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
1329         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1330
1331 LDAP_F( int )
1332 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1333         LDAPDN_rewrite_func *func, unsigned flags ));
1334
1335 LDAP_F( char * )
1336 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1337
1338 LDAP_F( char * )
1339 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1340
1341 LDAP_F( char * )
1342 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1343
1344 LDAP_F( int )
1345 ldap_get_dn_ber LDAP_P((
1346         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1347
1348 LDAP_F( int )
1349 ldap_get_attribute_ber LDAP_P((
1350         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1351         struct berval **vals ));
1352
1353 /*
1354  * in getattr.c
1355  */
1356 LDAP_F( char * )
1357 ldap_first_attribute LDAP_P((
1358         LDAP *ld,
1359         LDAPMessage *entry,
1360         BerElement **ber ));
1361
1362 LDAP_F( char * )
1363 ldap_next_attribute LDAP_P((
1364         LDAP *ld,
1365         LDAPMessage *entry,
1366         BerElement *ber ));
1367
1368
1369 /*
1370  * in getvalues.c
1371  */
1372 LDAP_F( struct berval ** )
1373 ldap_get_values_len LDAP_P((
1374         LDAP *ld,
1375         LDAPMessage *entry,
1376         LDAP_CONST char *target ));
1377
1378 LDAP_F( int )
1379 ldap_count_values_len LDAP_P((
1380         struct berval **vals ));
1381
1382 LDAP_F( void )
1383 ldap_value_free_len LDAP_P((
1384         struct berval **vals ));
1385
1386 #if LDAP_DEPRECATED
1387 LDAP_F( char ** )
1388 ldap_get_values LDAP_P((        /* deprecated */
1389         LDAP *ld,
1390         LDAPMessage *entry,
1391         LDAP_CONST char *target ));
1392
1393 LDAP_F( int )
1394 ldap_count_values LDAP_P((      /* deprecated */
1395         char **vals ));
1396
1397 LDAP_F( void )
1398 ldap_value_free LDAP_P((        /* deprecated */
1399         char **vals ));
1400 #endif
1401
1402 /*
1403  * in result.c:
1404  */
1405 LDAP_F( int )
1406 ldap_result LDAP_P((
1407         LDAP *ld,
1408         int msgid,
1409         int all,
1410         struct timeval *timeout,
1411         LDAPMessage **result ));
1412
1413 LDAP_F( int )
1414 ldap_msgtype LDAP_P((
1415         LDAPMessage *lm ));
1416
1417 LDAP_F( int )
1418 ldap_msgid   LDAP_P((
1419         LDAPMessage *lm ));
1420
1421 LDAP_F( int )
1422 ldap_msgfree LDAP_P((
1423         LDAPMessage *lm ));
1424
1425 LDAP_F( int )
1426 ldap_msgdelete LDAP_P((
1427         LDAP *ld,
1428         int msgid ));
1429
1430
1431 /*
1432  * in search.c:
1433  */
1434 LDAP_F( int )
1435 ldap_search_ext LDAP_P((
1436         LDAP                    *ld,
1437         LDAP_CONST char *base,
1438         int                             scope,
1439         LDAP_CONST char *filter,
1440         char                    **attrs,
1441         int                             attrsonly,
1442         LDAPControl             **serverctrls,
1443         LDAPControl             **clientctrls,
1444         struct timeval  *timeout,
1445         int                             sizelimit,
1446         int                             *msgidp ));
1447
1448 LDAP_F( int )
1449 ldap_search_ext_s LDAP_P((
1450         LDAP                    *ld,
1451         LDAP_CONST char *base,
1452         int                             scope,
1453         LDAP_CONST char *filter,
1454         char                    **attrs,
1455         int                             attrsonly,
1456         LDAPControl             **serverctrls,
1457         LDAPControl             **clientctrls,
1458         struct timeval  *timeout,
1459         int                             sizelimit,
1460         LDAPMessage             **res ));
1461
1462 #if LDAP_DEPRECATED
1463 LDAP_F( int )
1464 ldap_search LDAP_P((    /* deprecated */
1465         LDAP *ld,
1466         LDAP_CONST char *base,
1467         int scope,
1468         LDAP_CONST char *filter,
1469         char **attrs,
1470         int attrsonly ));
1471
1472 LDAP_F( int )
1473 ldap_search_s LDAP_P((  /* deprecated */
1474         LDAP *ld,
1475         LDAP_CONST char *base,
1476         int scope,
1477         LDAP_CONST char *filter,
1478         char **attrs,
1479         int attrsonly,
1480         LDAPMessage **res ));
1481
1482 LDAP_F( int )
1483 ldap_search_st LDAP_P(( /* deprecated */
1484         LDAP *ld,
1485         LDAP_CONST char *base,
1486         int scope,
1487         LDAP_CONST char *filter,
1488     char **attrs,
1489         int attrsonly,
1490         struct timeval *timeout,
1491         LDAPMessage **res ));
1492 #endif
1493
1494 /*
1495  * in unbind.c
1496  */
1497 LDAP_F( int )
1498 ldap_unbind_ext LDAP_P((
1499         LDAP                    *ld,
1500         LDAPControl             **serverctrls,
1501         LDAPControl             **clientctrls));
1502
1503 LDAP_F( int )
1504 ldap_unbind_ext_s LDAP_P((
1505         LDAP                    *ld,
1506         LDAPControl             **serverctrls,
1507         LDAPControl             **clientctrls));
1508
1509 #if LDAP_DEPRECATED
1510 LDAP_F( int )
1511 ldap_unbind LDAP_P(( /* deprecated */
1512         LDAP *ld ));
1513
1514 LDAP_F( int )
1515 ldap_unbind_s LDAP_P(( /* deprecated */
1516         LDAP *ld ));
1517 #endif
1518
1519 /*
1520  * in filter.c
1521  */
1522 LDAP_F( int )
1523 ldap_put_vrFilter LDAP_P((
1524         BerElement *ber,
1525         const char *vrf ));
1526
1527 /*
1528  * in free.c
1529  */
1530
1531 LDAP_F( void * )
1532 ldap_memalloc LDAP_P((
1533         ber_len_t s ));
1534
1535 LDAP_F( void * )
1536 ldap_memrealloc LDAP_P((
1537         void* p,
1538         ber_len_t s ));
1539
1540 LDAP_F( void * )
1541 ldap_memcalloc LDAP_P((
1542         ber_len_t n,
1543         ber_len_t s ));
1544
1545 LDAP_F( void )
1546 ldap_memfree LDAP_P((
1547         void* p ));
1548
1549 LDAP_F( void )
1550 ldap_memvfree LDAP_P((
1551         void** v ));
1552
1553 LDAP_F( char * )
1554 ldap_strdup LDAP_P((
1555         LDAP_CONST char * ));
1556
1557 LDAP_F( void )
1558 ldap_mods_free LDAP_P((
1559         LDAPMod **mods,
1560         int freemods ));
1561
1562
1563 #if LDAP_DEPRECATED
1564 /*
1565  * in sort.c (deprecated)
1566  */
1567 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1568         LDAP_CONST char *left,
1569         LDAP_CONST char *right ));
1570
1571 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1572         LDAP_CONST void *left,
1573         LDAP_CONST void *right ));
1574
1575 LDAP_F( int )   /* deprecated */
1576 ldap_sort_entries LDAP_P(( LDAP *ld,
1577         LDAPMessage **chain,
1578         LDAP_CONST char *attr,
1579         LDAP_SORT_AD_CMP_PROC *cmp ));
1580
1581 LDAP_F( int )   /* deprecated */
1582 ldap_sort_values LDAP_P((
1583         LDAP *ld,
1584         char **vals,
1585         LDAP_SORT_AV_CMP_PROC *cmp ));
1586
1587 LDAP_F( int ) /* deprecated */
1588 ldap_sort_strcasecmp LDAP_P((
1589         LDAP_CONST void *a,
1590         LDAP_CONST void *b ));
1591 #endif
1592
1593 /*
1594  * in url.c
1595  */
1596 LDAP_F( int )
1597 ldap_is_ldap_url LDAP_P((
1598         LDAP_CONST char *url ));
1599
1600 LDAP_F( int )
1601 ldap_is_ldaps_url LDAP_P((
1602         LDAP_CONST char *url ));
1603
1604 LDAP_F( int )
1605 ldap_is_ldapi_url LDAP_P((
1606         LDAP_CONST char *url ));
1607
1608 LDAP_F( int )
1609 ldap_url_parse LDAP_P((
1610         LDAP_CONST char *url,
1611         LDAPURLDesc **ludpp ));
1612
1613 LDAP_F( char * )
1614 ldap_url_desc2str LDAP_P((
1615         LDAPURLDesc *ludp ));
1616
1617 LDAP_F( void )
1618 ldap_free_urldesc LDAP_P((
1619         LDAPURLDesc *ludp ));
1620
1621
1622 /*
1623  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1624  *  in cancel.c
1625  */
1626 #define LDAP_API_FEATURE_CANCEL 1000
1627
1628 LDAP_F( int )
1629 ldap_cancel LDAP_P(( LDAP *ld,
1630         int cancelid,
1631         LDAPControl             **sctrls,
1632         LDAPControl             **cctrls,
1633         int                             *msgidp ));
1634
1635 LDAP_F( int )
1636 ldap_cancel_s LDAP_P((
1637         LDAP *ld,
1638         int cancelid,
1639         LDAPControl **sctrl,
1640         LDAPControl **cctrl ));
1641
1642 /*
1643  * LDAP Server Side Sort
1644  *      in sortctrl.c
1645  */
1646 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1647
1648 /* structure for a sort-key */
1649 typedef struct ldapsortkey {
1650         char *  attributeType;
1651         char *  orderingRule;
1652         int     reverseOrder;
1653 } LDAPSortKey;
1654
1655 LDAP_F( int )
1656 ldap_create_sort_keylist LDAP_P((
1657         LDAPSortKey ***sortKeyList,
1658         char        *keyString ));
1659
1660 LDAP_F( void )
1661 ldap_free_sort_keylist LDAP_P((
1662         LDAPSortKey **sortkeylist ));
1663
1664 LDAP_F( int )
1665 ldap_create_sort_control LDAP_P((
1666         LDAP *ld,
1667         LDAPSortKey **keyList,
1668         int ctl_iscritical,
1669         LDAPControl **ctrlp ));
1670
1671 LDAP_F( int )
1672 ldap_parse_sort_control LDAP_P((
1673         LDAP           *ld,
1674         LDAPControl    **ctrlp,
1675         unsigned long  *result,
1676         char           **attribute ));
1677
1678
1679 /*
1680  * LDAP Virtual List View
1681  *      in vlvctrl.c
1682  */
1683 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1684
1685 /* structure for virtual list */
1686 typedef struct ldapvlvinfo {
1687         int             ldvlv_version;
1688     unsigned long   ldvlv_before_count;
1689     unsigned long   ldvlv_after_count;
1690     unsigned long   ldvlv_offset;
1691     unsigned long   ldvlv_count;
1692     struct berval *     ldvlv_attrvalue;
1693     struct berval *     ldvlv_context;
1694     void *                      ldvlv_extradata;
1695 } LDAPVLVInfo;
1696
1697 LDAP_F( int )
1698 ldap_create_vlv_control LDAP_P((
1699         LDAP *ld,
1700         LDAPVLVInfo *ldvlistp,
1701         LDAPControl **ctrlp ));
1702
1703 LDAP_F( int )
1704 ldap_parse_vlv_control LDAP_P((
1705         LDAP          *ld,
1706         LDAPControl   **ctrls,
1707         unsigned long *target_posp,
1708         unsigned long *list_countp,
1709         struct berval **contextp,
1710         int           *errcodep ));
1711
1712
1713 /*
1714  * LDAP Who Am I?
1715  *      in whoami.c
1716  */
1717 #define LDAP_API_FEATURE_WHOAMI 1000
1718
1719 LDAP_F( int )
1720 ldap_parse_whoami LDAP_P((
1721         LDAP *ld,
1722         LDAPMessage *res,
1723         struct berval **authzid ));
1724
1725 LDAP_F( int )
1726 ldap_whoami LDAP_P(( LDAP *ld,
1727         LDAPControl             **sctrls,
1728         LDAPControl             **cctrls,
1729         int                             *msgidp ));
1730
1731 LDAP_F( int )
1732 ldap_whoami_s LDAP_P((
1733         LDAP *ld,
1734         struct berval **authzid,
1735         LDAPControl **sctrls,
1736         LDAPControl **cctrls ));
1737
1738 /*
1739  * LDAP Password Modify
1740  *      in passwd.c
1741  */
1742 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1743
1744 LDAP_F( int )
1745 ldap_parse_passwd LDAP_P((
1746         LDAP *ld,
1747         LDAPMessage *res,
1748         struct berval *newpasswd ));
1749
1750 LDAP_F( int )
1751 ldap_passwd LDAP_P(( LDAP *ld,
1752         struct berval   *user,
1753         struct berval   *oldpw,
1754         struct berval   *newpw,
1755         LDAPControl             **sctrls,
1756         LDAPControl             **cctrls,
1757         int                             *msgidp ));
1758
1759 LDAP_F( int )
1760 ldap_passwd_s LDAP_P((
1761         LDAP *ld,
1762         struct berval   *user,
1763         struct berval   *oldpw,
1764         struct berval   *newpw,
1765         struct berval *newpasswd,
1766         LDAPControl **sctrls,
1767         LDAPControl **cctrls ));
1768
1769 LDAP_END_DECL
1770 #endif /* _LDAP_H */