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