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