git.sur5r.net Git - openldap/blob - include/ldap.h

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