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