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