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