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