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