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