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