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 TBD  */
 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_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
 589 /* Experimental result codes */
 590 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
 591
 592 /* LDAP Sync (4096) */
 593 #define LDAP_SYNC_REFRESH_REQUIRED              0x1000
 594
 595
 596 /* Private Use result codes */
 597 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
 598
 599 #define LDAP_X_SYNC_REFRESH_REQUIRED    0x4100 /* defunct */
 600 #define LDAP_X_ASSERTION_FAILED                 0x410f /* defunct */
 601
 602 /* for the LDAP No-Op control */
 603 #define LDAP_X_NO_OPERATION                             0x410e
 604
 605 /* for the Chaining Behavior control (consecutive result codes requested;
 606  * see <draft-sermersheim-ldap-chaining> ) */
 607 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
 608 #define LDAP_X_NO_REFERRALS_FOUND               0x4110
 609 #define LDAP_X_CANNOT_CHAIN                     0x4111
 610 #endif
 611
 612 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
 613 #ifdef LDAP_X_DISTPROC_BASE
 614 #define LDAP_X_INVALIDREFERENCE                 0x4112
 615 #endif
 616
 617 /* API Error Codes
 618  *
 619  * Based on draft-ietf-ldap-c-api-xx
 620  * but with new negative code values
 621  */
 622 #define LDAP_API_ERROR(n)               ((n)<0)
 623 #define LDAP_API_RESULT(n)              ((n)<=0)
 624
 625 #define LDAP_SERVER_DOWN                                (-1)
 626 #define LDAP_LOCAL_ERROR                                (-2)
 627 #define LDAP_ENCODING_ERROR                             (-3)
 628 #define LDAP_DECODING_ERROR                             (-4)
 629 #define LDAP_TIMEOUT                                    (-5)
 630 #define LDAP_AUTH_UNKNOWN                               (-6)
 631 #define LDAP_FILTER_ERROR                               (-7)
 632 #define LDAP_USER_CANCELLED                             (-8)
 633 #define LDAP_PARAM_ERROR                                (-9)
 634 #define LDAP_NO_MEMORY                                  (-10)
 635 #define LDAP_CONNECT_ERROR                              (-11)
 636 #define LDAP_NOT_SUPPORTED                              (-12)
 637 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 638 #define LDAP_NO_RESULTS_RETURNED                (-14)
 639 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)   /* Obsolete */
 640 #define LDAP_CLIENT_LOOP                                (-16)
 641 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 642
 643
 644 /*
 645  * This structure represents both ldap messages and ldap responses.
 646  * These are really the same, except in the case of search responses,
 647  * where a response has multiple messages.
 648  */
 649
 650 typedef struct ldapmsg LDAPMessage;
 651
 652 /* for modifications */
 653 typedef struct ldapmod {
 654         int             mod_op;
 655
 656 #define LDAP_MOD_OP                     (0x0007)
 657 #define LDAP_MOD_ADD            (0x0000)
 658 #define LDAP_MOD_DELETE         (0x0001)
 659 #define LDAP_MOD_REPLACE        (0x0002)
 660 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 661 #define LDAP_MOD_BVALUES        (0x0080)
 662 /* IMPORTANT: do not use code 0x1000 (or above),
 663  * it is used internally by the backends!
 664  * (see ldap/servers/slapd/slap.h)
 665  */
 666
 667         char            *mod_type;
 668         union mod_vals_u {
 669                 char            **modv_strvals;
 670                 struct berval   **modv_bvals;
 671         } mod_vals;
 672 #define mod_values      mod_vals.modv_strvals
 673 #define mod_bvalues     mod_vals.modv_bvals
 674 } LDAPMod;
 675
 676 /*
 677  * structure representing an ldap session which can
 678  * encompass connections to multiple servers (in the
 679  * face of referrals).
 680  */
 681 typedef struct ldap LDAP;
 682
 683 #define LDAP_DEREF_NEVER                0x00
 684 #define LDAP_DEREF_SEARCHING    0x01
 685 #define LDAP_DEREF_FINDING              0x02
 686 #define LDAP_DEREF_ALWAYS               0x03
 687
 688 #define LDAP_NO_LIMIT                   0
 689
 690 /* how many messages to retrieve results for */
 691 #define LDAP_MSG_ONE                    0x00
 692 #define LDAP_MSG_ALL                    0x01
 693 #define LDAP_MSG_RECEIVED               0x02
 694
 695 /*
 696  * types for ldap URL handling
 697  */
 698 typedef struct ldap_url_desc {
 699         struct ldap_url_desc *lud_next;
 700         char    *lud_scheme;
 701         char    *lud_host;
 702         int             lud_port;
 703         char    *lud_dn;
 704         char    **lud_attrs;
 705         int             lud_scope;
 706         char    *lud_filter;
 707         char    **lud_exts;
 708         int             lud_crit_exts;
 709 } LDAPURLDesc;
 710
 711 #define LDAP_URL_SUCCESS                0x00    /* Success */
 712 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 713 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 714
 715 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 716 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 717 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 718 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 719 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 720 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 721 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 722 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 723
 724 /*
 725  * The API draft spec says we should declare (or cause to be declared)
 726  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 727  */
 728 struct timeval;
 729
 730 /*
 731  * in options.c:
 732  */
 733 LDAP_F( int )
 734 ldap_get_option LDAP_P((
 735         LDAP *ld,
 736         int option,
 737         void *outvalue));
 738
 739 LDAP_F( int )
 740 ldap_set_option LDAP_P((
 741         LDAP *ld,
 742         int option,
 743         LDAP_CONST void *invalue));
 744
 745 /* V3 REBIND Function Callback Prototype */
 746 typedef int (LDAP_REBIND_PROC) LDAP_P((
 747         LDAP *ld, LDAP_CONST char *url,
 748         ber_tag_t request, ber_int_t msgid,
 749         void *params ));
 750
 751 LDAP_F( int )
 752 ldap_set_rebind_proc LDAP_P((
 753         LDAP *ld,
 754         LDAP_REBIND_PROC *rebind_proc,
 755         void *params ));
 756
 757 /* V3 referral selection Function Callback Prototype */
 758 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
 759         LDAP *ld, char ***refsp, int *cntp,
 760         void *params ));
 761
 762 LDAP_F( int )
 763 ldap_set_nextref_proc LDAP_P((
 764         LDAP *ld,
 765         LDAP_NEXTREF_PROC *nextref_proc,
 766         void *params ));
 767
 768 /*
 769  * in controls.c:
 770  */
 771 LDAP_F( int )
 772 ldap_create_control LDAP_P((
 773         LDAP_CONST char *requestOID,
 774         BerElement *ber,
 775         int iscritical,
 776         LDAPControl **ctrlp ));
 777
 778 LDAP_F( LDAPControl * )
 779 ldap_find_control LDAP_P((
 780         LDAP_CONST char *oid,
 781         LDAPControl **ctrls ));
 782
 783 LDAP_F( void )
 784 ldap_control_free LDAP_P((
 785         LDAPControl *ctrl ));
 786
 787 LDAP_F( void )
 788 ldap_controls_free LDAP_P((
 789         LDAPControl **ctrls ));
 790
 791 /*
 792  * in dnssrv.c:
 793  */
 794 LDAP_F( int )
 795 ldap_domain2dn LDAP_P((
 796         LDAP_CONST char* domain,
 797         char** dn ));
 798
 799 LDAP_F( int )
 800 ldap_dn2domain LDAP_P((
 801         LDAP_CONST char* dn,
 802         char** domain ));
 803
 804 LDAP_F( int )
 805 ldap_domain2hostlist LDAP_P((
 806         LDAP_CONST char *domain,
 807         char** hostlist ));
 808
 809 /*
 810  * in extended.c:
 811  */
 812 LDAP_F( int )
 813 ldap_extended_operation LDAP_P((
 814         LDAP                    *ld,
 815         LDAP_CONST char *reqoid,
 816         struct berval   *reqdata,
 817         LDAPControl             **serverctrls,
 818         LDAPControl             **clientctrls,
 819         int                             *msgidp ));
 820
 821 LDAP_F( int )
 822 ldap_extended_operation_s LDAP_P((
 823         LDAP                    *ld,
 824         LDAP_CONST char *reqoid,
 825         struct berval   *reqdata,
 826         LDAPControl             **serverctrls,
 827         LDAPControl             **clientctrls,
 828         char                    **retoidp,
 829         struct berval   **retdatap ));
 830
 831 LDAP_F( int )
 832 ldap_parse_extended_result LDAP_P((
 833         LDAP                    *ld,
 834         LDAPMessage             *res,
 835         char                    **retoidp,
 836         struct berval   **retdatap,
 837         int                             freeit ));
 838
 839 LDAP_F( int )
 840 ldap_parse_intermediate LDAP_P((
 841         LDAP                    *ld,
 842         LDAPMessage             *res,
 843         char                    **retoidp,
 844         struct berval   **retdatap,
 845         LDAPControl             ***serverctrls,
 846         int                             freeit ));
 847
 848
 849 /*
 850  * in abandon.c:
 851  */
 852 LDAP_F( int )
 853 ldap_abandon_ext LDAP_P((
 854         LDAP                    *ld,
 855         int                             msgid,
 856         LDAPControl             **serverctrls,
 857         LDAPControl             **clientctrls ));
 858
 859 #if LDAP_DEPRECATED
 860 LDAP_F( int )
 861 ldap_abandon LDAP_P((   /* deprecated */
 862         LDAP *ld,
 863         int msgid ));
 864 #endif
 865
 866 /*
 867  * in add.c:
 868  */
 869 LDAP_F( int )
 870 ldap_add_ext LDAP_P((
 871         LDAP                    *ld,
 872         LDAP_CONST char *dn,
 873         LDAPMod                 **attrs,
 874         LDAPControl             **serverctrls,
 875         LDAPControl             **clientctrls,
 876         int                     *msgidp ));
 877
 878 LDAP_F( int )
 879 ldap_add_ext_s LDAP_P((
 880         LDAP                    *ld,
 881         LDAP_CONST char *dn,
 882         LDAPMod                 **attrs,
 883         LDAPControl             **serverctrls,
 884         LDAPControl             **clientctrls ));
 885
 886 #if LDAP_DEPRECATED
 887 LDAP_F( int )
 888 ldap_add LDAP_P((       /* deprecated */
 889         LDAP *ld,
 890         LDAP_CONST char *dn,
 891         LDAPMod **attrs ));
 892
 893 LDAP_F( int )
 894 ldap_add_s LDAP_P((     /* deprecated */
 895         LDAP *ld,
 896         LDAP_CONST char *dn,
 897         LDAPMod **attrs ));
 898 #endif
 899
 900
 901 /*
 902  * in sasl.c:
 903  */
 904 LDAP_F( int )
 905 ldap_sasl_bind LDAP_P((
 906         LDAP                    *ld,
 907         LDAP_CONST char *dn,
 908         LDAP_CONST char *mechanism,
 909         struct berval   *cred,
 910         LDAPControl             **serverctrls,
 911         LDAPControl             **clientctrls,
 912         int                             *msgidp ));
 913
 914 /* Interaction flags (should be passed about in a control)
 915  *  Automatic (default): use defaults, prompt otherwise
 916  *  Interactive: prompt always
 917  *  Quiet: never prompt
 918  */
 919 #define LDAP_SASL_AUTOMATIC             0U
 920 #define LDAP_SASL_INTERACTIVE   1U
 921 #define LDAP_SASL_QUIET                 2U
 922
 923 /*
 924  * V3 SASL Interaction Function Callback Prototype
 925  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 926  *  should likely passed in a control (and provided controls)
 927  */
 928 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 929         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 930
 931 LDAP_F( int )
 932 ldap_sasl_interactive_bind_s LDAP_P((
 933         LDAP *ld,
 934         LDAP_CONST char *dn, /* usually NULL */
 935         LDAP_CONST char *saslMechanism,
 936         LDAPControl **serverControls,
 937         LDAPControl **clientControls,
 938
 939         /* should be client controls */
 940         unsigned flags,
 941         LDAP_SASL_INTERACT_PROC *proc,
 942         void *defaults ));
 943
 944 LDAP_F( int )
 945 ldap_sasl_bind_s LDAP_P((
 946         LDAP                    *ld,
 947         LDAP_CONST char *dn,
 948         LDAP_CONST char *mechanism,
 949         struct berval   *cred,
 950         LDAPControl             **serverctrls,
 951         LDAPControl             **clientctrls,
 952         struct berval   **servercredp ));
 953
 954 LDAP_F( int )
 955 ldap_parse_sasl_bind_result LDAP_P((
 956         LDAP                    *ld,
 957         LDAPMessage             *res,
 958         struct berval   **servercredp,
 959         int                             freeit ));
 960
 961 #if LDAP_DEPRECATED
 962 /*
 963  * in bind.c:
 964  *      (deprecated)
 965  */
 966 LDAP_F( int )
 967 ldap_bind LDAP_P((      /* deprecated */
 968         LDAP *ld,
 969         LDAP_CONST char *who,
 970         LDAP_CONST char *passwd,
 971         int authmethod ));
 972
 973 LDAP_F( int )
 974 ldap_bind_s LDAP_P((    /* deprecated */
 975         LDAP *ld,
 976         LDAP_CONST char *who,
 977         LDAP_CONST char *cred,
 978         int authmethod ));
 979
 980 /*
 981  * in sbind.c:
 982  */
 983 LDAP_F( int )
 984 ldap_simple_bind LDAP_P(( /* deprecated */
 985         LDAP *ld,
 986         LDAP_CONST char *who,
 987         LDAP_CONST char *passwd ));
 988
 989 LDAP_F( int )
 990 ldap_simple_bind_s LDAP_P(( /* deprecated */
 991         LDAP *ld,
 992         LDAP_CONST char *who,
 993         LDAP_CONST char *passwd ));
 994
 995
 996 /*
 997  * in kbind.c:
 998  *      (deprecated)
 999  */
1000 LDAP_F( int )
1001 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1002         LDAP *ld,
1003         LDAP_CONST char *who ));
1004
1005 LDAP_F( int )
1006 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1007         LDAP *ld,
1008         LDAP_CONST char *who ));
1009
1010 LDAP_F( int )
1011 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1012         LDAP *ld,
1013         LDAP_CONST char *who ));
1014
1015 LDAP_F( int )
1016 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1017         LDAP *ld,
1018         LDAP_CONST char *who ));
1019
1020 LDAP_F( int )
1021 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1022         LDAP *ld,
1023         LDAP_CONST char *who ));
1024 #endif
1025
1026
1027 /*
1028  * in compare.c:
1029  */
1030 LDAP_F( int )
1031 ldap_compare_ext LDAP_P((
1032         LDAP                    *ld,
1033         LDAP_CONST char *dn,
1034         LDAP_CONST char *attr,
1035         struct berval   *bvalue,
1036         LDAPControl             **serverctrls,
1037         LDAPControl             **clientctrls,
1038         int                     *msgidp ));
1039
1040 LDAP_F( int )
1041 ldap_compare_ext_s LDAP_P((
1042         LDAP                    *ld,
1043         LDAP_CONST char *dn,
1044         LDAP_CONST char *attr,
1045         struct berval   *bvalue,
1046         LDAPControl             **serverctrls,
1047         LDAPControl             **clientctrls ));
1048
1049 #if LDAP_DEPRECATED
1050 LDAP_F( int )
1051 ldap_compare LDAP_P((   /* deprecated */
1052         LDAP *ld,
1053         LDAP_CONST char *dn,
1054         LDAP_CONST char *attr,
1055         LDAP_CONST char *value ));
1056
1057 LDAP_F( int )
1058 ldap_compare_s LDAP_P(( /* deprecated */
1059         LDAP *ld,
1060         LDAP_CONST char *dn,
1061         LDAP_CONST char *attr,
1062         LDAP_CONST char *value ));
1063 #endif
1064
1065
1066 /*
1067  * in delete.c:
1068  */
1069 LDAP_F( int )
1070 ldap_delete_ext LDAP_P((
1071         LDAP                    *ld,
1072         LDAP_CONST char *dn,
1073         LDAPControl             **serverctrls,
1074         LDAPControl             **clientctrls,
1075         int                     *msgidp ));
1076
1077 LDAP_F( int )
1078 ldap_delete_ext_s LDAP_P((
1079         LDAP                    *ld,
1080         LDAP_CONST char *dn,
1081         LDAPControl             **serverctrls,
1082         LDAPControl             **clientctrls ));
1083
1084 #if LDAP_DEPRECATED
1085 LDAP_F( int )
1086 ldap_delete LDAP_P((    /* deprecated */
1087         LDAP *ld,
1088         LDAP_CONST char *dn ));
1089
1090 LDAP_F( int )
1091 ldap_delete_s LDAP_P((  /* deprecated */
1092         LDAP *ld,
1093         LDAP_CONST char *dn ));
1094 #endif
1095
1096
1097 /*
1098  * in error.c:
1099  */
1100 LDAP_F( int )
1101 ldap_parse_result LDAP_P((
1102         LDAP                    *ld,
1103         LDAPMessage             *res,
1104         int                             *errcodep,
1105         char                    **matcheddnp,
1106         char                    **errmsgp,
1107         char                    ***referralsp,
1108         LDAPControl             ***serverctrls,
1109         int                             freeit ));
1110
1111 LDAP_F( char * )
1112 ldap_err2string LDAP_P((
1113         int err ));
1114
1115 #if LDAP_DEPRECATED
1116 LDAP_F( int )
1117 ldap_result2error LDAP_P((      /* deprecated */
1118         LDAP *ld,
1119         LDAPMessage *r,
1120         int freeit ));
1121
1122 LDAP_F( void )
1123 ldap_perror LDAP_P((    /* deprecated */
1124         LDAP *ld,
1125         LDAP_CONST char *s ));
1126 #endif
1127
1128
1129 /*
1130  * in modify.c:
1131  */
1132 LDAP_F( int )
1133 ldap_modify_ext LDAP_P((
1134         LDAP                    *ld,
1135         LDAP_CONST char *dn,
1136         LDAPMod                 **mods,
1137         LDAPControl             **serverctrls,
1138         LDAPControl             **clientctrls,
1139         int                     *msgidp ));
1140
1141 LDAP_F( int )
1142 ldap_modify_ext_s LDAP_P((
1143         LDAP                    *ld,
1144         LDAP_CONST char *dn,
1145         LDAPMod                 **mods,
1146         LDAPControl             **serverctrls,
1147         LDAPControl             **clientctrls ));
1148
1149 #if LDAP_DEPRECATED
1150 LDAP_F( int )
1151 ldap_modify LDAP_P((    /* deprecated */
1152         LDAP *ld,
1153         LDAP_CONST char *dn,
1154         LDAPMod **mods ));
1155
1156 LDAP_F( int )
1157 ldap_modify_s LDAP_P((  /* deprecated */
1158         LDAP *ld,
1159         LDAP_CONST char *dn,
1160         LDAPMod **mods ));
1161 #endif
1162
1163
1164 /*
1165  * in modrdn.c:
1166  */
1167 LDAP_F( int )
1168 ldap_rename LDAP_P((
1169         LDAP *ld,
1170         LDAP_CONST char *dn,
1171         LDAP_CONST char *newrdn,
1172         LDAP_CONST char *newSuperior,
1173         int deleteoldrdn,
1174         LDAPControl **sctrls,
1175         LDAPControl **cctrls,
1176         int *msgidp ));
1177
1178 LDAP_F( int )
1179 ldap_rename_s LDAP_P((
1180         LDAP *ld,
1181         LDAP_CONST char *dn,
1182         LDAP_CONST char *newrdn,
1183         LDAP_CONST char *newSuperior,
1184         int deleteoldrdn,
1185         LDAPControl **sctrls,
1186         LDAPControl **cctrls ));
1187
1188 #if LDAP_DEPRECATED
1189 LDAP_F( int )
1190 ldap_rename2 LDAP_P((   /* deprecated */
1191         LDAP *ld,
1192         LDAP_CONST char *dn,
1193         LDAP_CONST char *newrdn,
1194         LDAP_CONST char *newSuperior,
1195         int deleteoldrdn ));
1196
1197 LDAP_F( int )
1198 ldap_rename2_s LDAP_P(( /* deprecated */
1199         LDAP *ld,
1200         LDAP_CONST char *dn,
1201         LDAP_CONST char *newrdn,
1202         LDAP_CONST char *newSuperior,
1203         int deleteoldrdn ));
1204
1205 LDAP_F( int )
1206 ldap_modrdn LDAP_P((    /* deprecated */
1207         LDAP *ld,
1208         LDAP_CONST char *dn,
1209         LDAP_CONST char *newrdn ));
1210
1211 LDAP_F( int )
1212 ldap_modrdn_s LDAP_P((  /* deprecated */
1213         LDAP *ld,
1214         LDAP_CONST char *dn,
1215         LDAP_CONST char *newrdn ));
1216
1217 LDAP_F( int )
1218 ldap_modrdn2 LDAP_P((   /* deprecated */
1219         LDAP *ld,
1220         LDAP_CONST char *dn,
1221         LDAP_CONST char *newrdn,
1222         int deleteoldrdn ));
1223
1224 LDAP_F( int )
1225 ldap_modrdn2_s LDAP_P(( /* deprecated */
1226         LDAP *ld,
1227         LDAP_CONST char *dn,
1228         LDAP_CONST char *newrdn,
1229         int deleteoldrdn));
1230 #endif
1231
1232
1233 /*
1234  * in open.c:
1235  */
1236 #if LDAP_DEPRECATED
1237 LDAP_F( LDAP * )
1238 ldap_init LDAP_P(( /* deprecated */
1239         LDAP_CONST char *host,
1240         int port ));
1241
1242 LDAP_F( LDAP * )
1243 ldap_open LDAP_P((      /* deprecated */
1244         LDAP_CONST char *host,
1245         int port ));
1246 #endif
1247
1248 LDAP_F( int )
1249 ldap_create LDAP_P((
1250         LDAP **ldp ));
1251
1252 LDAP_F( int )
1253 ldap_initialize LDAP_P((
1254         LDAP **ldp,
1255         LDAP_CONST char *url ));
1256
1257 /*
1258  * in tls.c
1259  */
1260
1261 LDAP_F( int )
1262 ldap_tls_inplace LDAP_P((
1263         LDAP *ld ));
1264
1265 LDAP_F( int )
1266 ldap_start_tls LDAP_P((
1267         LDAP *ld,
1268         LDAPControl **serverctrls,
1269         LDAPControl **clientctrls,
1270         int *msgidp ));
1271
1272 LDAP_F( int )
1273 ldap_install_tls LDAP_P((
1274         LDAP *ld ));
1275
1276 LDAP_F( int )
1277 ldap_start_tls_s LDAP_P((
1278         LDAP *ld,
1279         LDAPControl **serverctrls,
1280         LDAPControl **clientctrls ));
1281
1282 /*
1283  * in messages.c:
1284  */
1285 LDAP_F( LDAPMessage * )
1286 ldap_first_message LDAP_P((
1287         LDAP *ld,
1288         LDAPMessage *chain ));
1289
1290 LDAP_F( LDAPMessage * )
1291 ldap_next_message LDAP_P((
1292         LDAP *ld,
1293         LDAPMessage *msg ));
1294
1295 LDAP_F( int )
1296 ldap_count_messages LDAP_P((
1297         LDAP *ld,
1298         LDAPMessage *chain ));
1299
1300 /*
1301  * in references.c:
1302  */
1303 LDAP_F( LDAPMessage * )
1304 ldap_first_reference LDAP_P((
1305         LDAP *ld,
1306         LDAPMessage *chain ));
1307
1308 LDAP_F( LDAPMessage * )
1309 ldap_next_reference LDAP_P((
1310         LDAP *ld,
1311         LDAPMessage *ref ));
1312
1313 LDAP_F( int )
1314 ldap_count_references LDAP_P((
1315         LDAP *ld,
1316         LDAPMessage *chain ));
1317
1318 LDAP_F( int )
1319 ldap_parse_reference LDAP_P((
1320         LDAP                    *ld,
1321         LDAPMessage             *ref,
1322         char                    ***referralsp,
1323         LDAPControl             ***serverctrls,
1324         int                             freeit));
1325
1326
1327 /*
1328  * in getentry.c:
1329  */
1330 LDAP_F( LDAPMessage * )
1331 ldap_first_entry LDAP_P((
1332         LDAP *ld,
1333         LDAPMessage *chain ));
1334
1335 LDAP_F( LDAPMessage * )
1336 ldap_next_entry LDAP_P((
1337         LDAP *ld,
1338         LDAPMessage *entry ));
1339
1340 LDAP_F( int )
1341 ldap_count_entries LDAP_P((
1342         LDAP *ld,
1343         LDAPMessage *chain ));
1344
1345 LDAP_F( int )
1346 ldap_get_entry_controls LDAP_P((
1347         LDAP                    *ld,
1348         LDAPMessage             *entry,
1349         LDAPControl             ***serverctrls));
1350
1351
1352 /*
1353  * in addentry.c
1354  */
1355 LDAP_F( LDAPMessage * )
1356 ldap_delete_result_entry LDAP_P((
1357         LDAPMessage **list,
1358         LDAPMessage *e ));
1359
1360 LDAP_F( void )
1361 ldap_add_result_entry LDAP_P((
1362         LDAPMessage **list,
1363         LDAPMessage *e ));
1364
1365
1366 /*
1367  * in getdn.c
1368  */
1369 LDAP_F( char * )
1370 ldap_get_dn LDAP_P((
1371         LDAP *ld,
1372         LDAPMessage *entry ));
1373
1374 typedef struct ldap_ava {
1375         struct berval la_attr;
1376         struct berval la_value;
1377         unsigned la_flags;
1378 #define LDAP_AVA_NULL                           0x0000U
1379 #define LDAP_AVA_STRING                         0x0001U
1380 #define LDAP_AVA_BINARY                         0x0002U
1381 #define LDAP_AVA_NONPRINTABLE           0x0004U
1382 #define LDAP_AVA_FREE_ATTR                      0x0010U
1383 #define LDAP_AVA_FREE_VALUE                     0x0020U
1384
1385         void *la_private;
1386 } LDAPAVA;
1387
1388 typedef LDAPAVA** LDAPRDN;
1389 typedef LDAPRDN* LDAPDN;
1390
1391 /* DN formats */
1392 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1393 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1394 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1395 #define LDAP_DN_FORMAT_DCE                      0x0030U
1396 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1397 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1398 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1399 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1400
1401 /* DN flags */
1402 #define LDAP_DN_PRETTY                          0x0100U
1403 #define LDAP_DN_SKIP                            0x0200U
1404 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1405 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1406 #define LDAP_DN_PEDANTIC                        0xF000U
1407
1408 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1409 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1410
1411 LDAP_F( int )
1412 ldap_bv2dn LDAP_P((
1413         struct berval *bv,
1414         LDAPDN *dn,
1415         unsigned flags ));
1416
1417 LDAP_F( int )
1418 ldap_str2dn LDAP_P((
1419         LDAP_CONST char *str,
1420         LDAPDN *dn,
1421         unsigned flags ));
1422
1423 LDAP_F( int )
1424 ldap_dn2bv LDAP_P((
1425         LDAPDN dn,
1426         struct berval *bv,
1427         unsigned flags ));
1428
1429 LDAP_F( int )
1430 ldap_dn2str LDAP_P((
1431         LDAPDN dn,
1432         char **str,
1433         unsigned flags ));
1434
1435 LDAP_F( int )
1436 ldap_bv2rdn LDAP_P((
1437         struct berval *bv,
1438         LDAPRDN *rdn,
1439         char **next,
1440         unsigned flags ));
1441
1442 LDAP_F( int )
1443 ldap_str2rdn LDAP_P((
1444         LDAP_CONST char *str,
1445         LDAPRDN *rdn,
1446         char **next,
1447         unsigned flags ));
1448
1449 LDAP_F( int )
1450 ldap_rdn2bv LDAP_P((
1451         LDAPRDN rdn,
1452         struct berval *bv,
1453         unsigned flags ));
1454
1455 LDAP_F( int )
1456 ldap_rdn2str LDAP_P((
1457         LDAPRDN rdn,
1458         char **str,
1459         unsigned flags ));
1460
1461 LDAP_F( int )
1462 ldap_dn_normalize LDAP_P((
1463         LDAP_CONST char *in, unsigned iflags,
1464         char **out, unsigned oflags ));
1465
1466 LDAP_F( char * )
1467 ldap_dn2ufn LDAP_P(( /* deprecated */
1468         LDAP_CONST char *dn ));
1469
1470 LDAP_F( char ** )
1471 ldap_explode_dn LDAP_P(( /* deprecated */
1472         LDAP_CONST char *dn,
1473         int notypes ));
1474
1475 LDAP_F( char ** )
1476 ldap_explode_rdn LDAP_P(( /* deprecated */
1477         LDAP_CONST char *rdn,
1478         int notypes ));
1479
1480 typedef int LDAPDN_rewrite_func
1481         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1482
1483 LDAP_F( int )
1484 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1485         LDAPDN_rewrite_func *func, unsigned flags ));
1486
1487 LDAP_F( char * )
1488 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1489
1490 LDAP_F( char * )
1491 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1492
1493 LDAP_F( char * )
1494 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1495
1496 LDAP_F( int )
1497 ldap_get_dn_ber LDAP_P((
1498         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1499
1500 LDAP_F( int )
1501 ldap_get_attribute_ber LDAP_P((
1502         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1503         struct berval **vals ));
1504
1505 /*
1506  * in getattr.c
1507  */
1508 LDAP_F( char * )
1509 ldap_first_attribute LDAP_P((
1510         LDAP *ld,
1511         LDAPMessage *entry,
1512         BerElement **ber ));
1513
1514 LDAP_F( char * )
1515 ldap_next_attribute LDAP_P((
1516         LDAP *ld,
1517         LDAPMessage *entry,
1518         BerElement *ber ));
1519
1520
1521 /*
1522  * in getvalues.c
1523  */
1524 LDAP_F( struct berval ** )
1525 ldap_get_values_len LDAP_P((
1526         LDAP *ld,
1527         LDAPMessage *entry,
1528         LDAP_CONST char *target ));
1529
1530 LDAP_F( int )
1531 ldap_count_values_len LDAP_P((
1532         struct berval **vals ));
1533
1534 LDAP_F( void )
1535 ldap_value_free_len LDAP_P((
1536         struct berval **vals ));
1537
1538 #if LDAP_DEPRECATED
1539 LDAP_F( char ** )
1540 ldap_get_values LDAP_P((        /* deprecated */
1541         LDAP *ld,
1542         LDAPMessage *entry,
1543         LDAP_CONST char *target ));
1544
1545 LDAP_F( int )
1546 ldap_count_values LDAP_P((      /* deprecated */
1547         char **vals ));
1548
1549 LDAP_F( void )
1550 ldap_value_free LDAP_P((        /* deprecated */
1551         char **vals ));
1552 #endif
1553
1554 /*
1555  * in result.c:
1556  */
1557 LDAP_F( int )
1558 ldap_result LDAP_P((
1559         LDAP *ld,
1560         int msgid,
1561         int all,
1562         struct timeval *timeout,
1563         LDAPMessage **result ));
1564
1565 LDAP_F( int )
1566 ldap_msgtype LDAP_P((
1567         LDAPMessage *lm ));
1568
1569 LDAP_F( int )
1570 ldap_msgid   LDAP_P((
1571         LDAPMessage *lm ));
1572
1573 LDAP_F( int )
1574 ldap_msgfree LDAP_P((
1575         LDAPMessage *lm ));
1576
1577 LDAP_F( int )
1578 ldap_msgdelete LDAP_P((
1579         LDAP *ld,
1580         int msgid ));
1581
1582
1583 /*
1584  * in search.c:
1585  */
1586 LDAP_F( int )
1587 ldap_bv2escaped_filter_value LDAP_P((
1588         struct berval *in,
1589         struct berval *out ));
1590
1591 LDAP_F( int )
1592 ldap_search_ext LDAP_P((
1593         LDAP                    *ld,
1594         LDAP_CONST char *base,
1595         int                             scope,
1596         LDAP_CONST char *filter,
1597         char                    **attrs,
1598         int                             attrsonly,
1599         LDAPControl             **serverctrls,
1600         LDAPControl             **clientctrls,
1601         struct timeval  *timeout,
1602         int                             sizelimit,
1603         int                             *msgidp ));
1604
1605 LDAP_F( int )
1606 ldap_search_ext_s LDAP_P((
1607         LDAP                    *ld,
1608         LDAP_CONST char *base,
1609         int                             scope,
1610         LDAP_CONST char *filter,
1611         char                    **attrs,
1612         int                             attrsonly,
1613         LDAPControl             **serverctrls,
1614         LDAPControl             **clientctrls,
1615         struct timeval  *timeout,
1616         int                             sizelimit,
1617         LDAPMessage             **res ));
1618
1619 #if LDAP_DEPRECATED
1620 LDAP_F( int )
1621 ldap_search LDAP_P((    /* deprecated */
1622         LDAP *ld,
1623         LDAP_CONST char *base,
1624         int scope,
1625         LDAP_CONST char *filter,
1626         char **attrs,
1627         int attrsonly ));
1628
1629 LDAP_F( int )
1630 ldap_search_s LDAP_P((  /* deprecated */
1631         LDAP *ld,
1632         LDAP_CONST char *base,
1633         int scope,
1634         LDAP_CONST char *filter,
1635         char **attrs,
1636         int attrsonly,
1637         LDAPMessage **res ));
1638
1639 LDAP_F( int )
1640 ldap_search_st LDAP_P(( /* deprecated */
1641         LDAP *ld,
1642         LDAP_CONST char *base,
1643         int scope,
1644         LDAP_CONST char *filter,
1645     char **attrs,
1646         int attrsonly,
1647         struct timeval *timeout,
1648         LDAPMessage **res ));
1649 #endif
1650
1651 /*
1652  * in unbind.c
1653  */
1654 LDAP_F( int )
1655 ldap_unbind_ext LDAP_P((
1656         LDAP                    *ld,
1657         LDAPControl             **serverctrls,
1658         LDAPControl             **clientctrls));
1659
1660 LDAP_F( int )
1661 ldap_unbind_ext_s LDAP_P((
1662         LDAP                    *ld,
1663         LDAPControl             **serverctrls,
1664         LDAPControl             **clientctrls));
1665
1666 #if LDAP_DEPRECATED
1667 LDAP_F( int )
1668 ldap_unbind LDAP_P(( /* deprecated */
1669         LDAP *ld ));
1670
1671 LDAP_F( int )
1672 ldap_unbind_s LDAP_P(( /* deprecated */
1673         LDAP *ld ));
1674 #endif
1675
1676 /*
1677  * in filter.c
1678  */
1679 LDAP_F( int )
1680 ldap_put_vrFilter LDAP_P((
1681         BerElement *ber,
1682         const char *vrf ));
1683
1684 /*
1685  * in free.c
1686  */
1687
1688 LDAP_F( void * )
1689 ldap_memalloc LDAP_P((
1690         ber_len_t s ));
1691
1692 LDAP_F( void * )
1693 ldap_memrealloc LDAP_P((
1694         void* p,
1695         ber_len_t s ));
1696
1697 LDAP_F( void * )
1698 ldap_memcalloc LDAP_P((
1699         ber_len_t n,
1700         ber_len_t s ));
1701
1702 LDAP_F( void )
1703 ldap_memfree LDAP_P((
1704         void* p ));
1705
1706 LDAP_F( void )
1707 ldap_memvfree LDAP_P((
1708         void** v ));
1709
1710 LDAP_F( char * )
1711 ldap_strdup LDAP_P((
1712         LDAP_CONST char * ));
1713
1714 LDAP_F( void )
1715 ldap_mods_free LDAP_P((
1716         LDAPMod **mods,
1717         int freemods ));
1718
1719
1720 #if LDAP_DEPRECATED
1721 /*
1722  * in sort.c (deprecated)
1723  */
1724 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1725         LDAP_CONST char *left,
1726         LDAP_CONST char *right ));
1727
1728 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1729         LDAP_CONST void *left,
1730         LDAP_CONST void *right ));
1731
1732 LDAP_F( int )   /* deprecated */
1733 ldap_sort_entries LDAP_P(( LDAP *ld,
1734         LDAPMessage **chain,
1735         LDAP_CONST char *attr,
1736         LDAP_SORT_AD_CMP_PROC *cmp ));
1737
1738 LDAP_F( int )   /* deprecated */
1739 ldap_sort_values LDAP_P((
1740         LDAP *ld,
1741         char **vals,
1742         LDAP_SORT_AV_CMP_PROC *cmp ));
1743
1744 LDAP_F( int ) /* deprecated */
1745 ldap_sort_strcasecmp LDAP_P((
1746         LDAP_CONST void *a,
1747         LDAP_CONST void *b ));
1748 #endif
1749
1750 /*
1751  * in url.c
1752  */
1753 LDAP_F( int )
1754 ldap_is_ldap_url LDAP_P((
1755         LDAP_CONST char *url ));
1756
1757 LDAP_F( int )
1758 ldap_is_ldaps_url LDAP_P((
1759         LDAP_CONST char *url ));
1760
1761 LDAP_F( int )
1762 ldap_is_ldapi_url LDAP_P((
1763         LDAP_CONST char *url ));
1764
1765 LDAP_F( int )
1766 ldap_url_parse LDAP_P((
1767         LDAP_CONST char *url,
1768         LDAPURLDesc **ludpp ));
1769
1770 LDAP_F( char * )
1771 ldap_url_desc2str LDAP_P((
1772         LDAPURLDesc *ludp ));
1773
1774 LDAP_F( void )
1775 ldap_free_urldesc LDAP_P((
1776         LDAPURLDesc *ludp ));
1777
1778
1779 /*
1780  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1781  *  in cancel.c
1782  */
1783 #define LDAP_API_FEATURE_CANCEL 1000
1784
1785 LDAP_F( int )
1786 ldap_cancel LDAP_P(( LDAP *ld,
1787         int cancelid,
1788         LDAPControl             **sctrls,
1789         LDAPControl             **cctrls,
1790         int                             *msgidp ));
1791
1792 LDAP_F( int )
1793 ldap_cancel_s LDAP_P(( LDAP *ld,
1794         int cancelid,
1795         LDAPControl **sctrl,
1796         LDAPControl **cctrl ));
1797
1798 /*
1799  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1800  *  in turn.c
1801  */
1802 #define LDAP_API_FEATURE_TURN 1000
1803
1804 LDAP_F( int )
1805 ldap_turn LDAP_P(( LDAP *ld,
1806         int mutual,
1807         LDAP_CONST char* identifier,
1808         LDAPControl             **sctrls,
1809         LDAPControl             **cctrls,
1810         int                             *msgidp ));
1811
1812 LDAP_F( int )
1813 ldap_turn_s LDAP_P(( LDAP *ld,
1814         int mutual,
1815         LDAP_CONST char* identifier,
1816         LDAPControl **sctrl,
1817         LDAPControl **cctrl ));
1818
1819 /*
1820  * LDAP Paged Results
1821  *      in pagectrl.c
1822  */
1823 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1824
1825 LDAP_F( int )
1826 ldap_create_page_control_value LDAP_P((
1827         LDAP *ld,
1828         ber_int_t pagesize,
1829         struct berval *cookie,
1830         struct berval *value ));
1831
1832 LDAP_F( int )
1833 ldap_create_page_control LDAP_P((
1834         LDAP *ld,
1835         ber_int_t pagesize,
1836         struct berval *cookie,
1837         int iscritical,
1838         LDAPControl **ctrlp ));
1839
1840 #if LDAP_DEPRECATED
1841 LDAP_F( int )
1842 ldap_parse_page_control LDAP_P((
1843         LDAP *ld,
1844         LDAPControl **ctrls,
1845         ber_int_t *count,
1846         struct berval **cookie ));
1847 #endif
1848
1849 LDAP_F( int )
1850 ldap_parse_pageresponse_control LDAP_P((
1851         LDAP *ld,
1852         LDAPControl *ctrl,
1853         ber_int_t *count,
1854         struct berval *cookie ));
1855
1856 /*
1857  * LDAP Server Side Sort
1858  *      in sortctrl.c
1859  */
1860 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1861
1862 /* structure for a sort-key */
1863 typedef struct ldapsortkey {
1864         char *attributeType;
1865         char *orderingRule;
1866         int reverseOrder;
1867 } LDAPSortKey;
1868
1869 LDAP_F( int )
1870 ldap_create_sort_keylist LDAP_P((
1871         LDAPSortKey ***sortKeyList,
1872         char *keyString ));
1873
1874 LDAP_F( void )
1875 ldap_free_sort_keylist LDAP_P((
1876         LDAPSortKey **sortkeylist ));
1877
1878 LDAP_F( int )
1879 ldap_create_sort_control_value LDAP_P((
1880         LDAP *ld,
1881         LDAPSortKey **keyList,
1882         struct berval *value ));
1883
1884 LDAP_F( int )
1885 ldap_create_sort_control LDAP_P((
1886         LDAP *ld,
1887         LDAPSortKey **keyList,
1888         int iscritical,
1889         LDAPControl **ctrlp ));
1890
1891 LDAP_F( int )
1892 ldap_parse_sortresponse_control LDAP_P((
1893         LDAP *ld,
1894         LDAPControl *ctrl,
1895         ber_int_t *result,
1896         char **attribute ));
1897
1898 /*
1899  * LDAP Virtual List View
1900  *      in vlvctrl.c
1901  */
1902 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1903
1904 /* structure for virtual list */
1905 typedef struct ldapvlvinfo {
1906         ber_int_t ldvlv_version;
1907     ber_int_t ldvlv_before_count;
1908     ber_int_t ldvlv_after_count;
1909     ber_int_t ldvlv_offset;
1910     ber_int_t ldvlv_count;
1911     struct berval *     ldvlv_attrvalue;
1912     struct berval *     ldvlv_context;
1913     void *                      ldvlv_extradata;
1914 } LDAPVLVInfo;
1915
1916 LDAP_F( int )
1917 ldap_create_vlv_control_value LDAP_P((
1918         LDAP *ld,
1919         LDAPVLVInfo *ldvlistp,
1920         struct berval *value));
1921
1922 LDAP_F( int )
1923 ldap_create_vlv_control LDAP_P((
1924         LDAP *ld,
1925         LDAPVLVInfo *ldvlistp,
1926         LDAPControl **ctrlp ));
1927
1928 LDAP_F( int )
1929 ldap_parse_vlvresponse_control LDAP_P((
1930         LDAP          *ld,
1931         LDAPControl   *ctrls,
1932         ber_int_t *target_posp,
1933         ber_int_t *list_countp,
1934         struct berval **contextp,
1935         int           *errcodep ));
1936
1937 /*
1938  * LDAP Who Am I?
1939  *      in whoami.c
1940  */
1941 #define LDAP_API_FEATURE_WHOAMI 1000
1942
1943 LDAP_F( int )
1944 ldap_parse_whoami LDAP_P((
1945         LDAP *ld,
1946         LDAPMessage *res,
1947         struct berval **authzid ));
1948
1949 LDAP_F( int )
1950 ldap_whoami LDAP_P(( LDAP *ld,
1951         LDAPControl             **sctrls,
1952         LDAPControl             **cctrls,
1953         int                             *msgidp ));
1954
1955 LDAP_F( int )
1956 ldap_whoami_s LDAP_P((
1957         LDAP *ld,
1958         struct berval **authzid,
1959         LDAPControl **sctrls,
1960         LDAPControl **cctrls ));
1961
1962 /*
1963  * LDAP Password Modify
1964  *      in passwd.c
1965  */
1966 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1967
1968 LDAP_F( int )
1969 ldap_parse_passwd LDAP_P((
1970         LDAP *ld,
1971         LDAPMessage *res,
1972         struct berval *newpasswd ));
1973
1974 LDAP_F( int )
1975 ldap_passwd LDAP_P(( LDAP *ld,
1976         struct berval   *user,
1977         struct berval   *oldpw,
1978         struct berval   *newpw,
1979         LDAPControl             **sctrls,
1980         LDAPControl             **cctrls,
1981         int                             *msgidp ));
1982
1983 LDAP_F( int )
1984 ldap_passwd_s LDAP_P((
1985         LDAP *ld,
1986         struct berval   *user,
1987         struct berval   *oldpw,
1988         struct berval   *newpw,
1989         struct berval *newpasswd,
1990         LDAPControl **sctrls,
1991         LDAPControl **cctrls ));
1992
1993 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
1994 /*
1995  * LDAP Password Policy controls
1996  *      in ppolicy.c
1997  */
1998 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
1999
2000 typedef enum passpolicyerror_enum {
2001        PP_passwordExpired = 0,
2002        PP_accountLocked = 1,
2003        PP_changeAfterReset = 2,
2004        PP_passwordModNotAllowed = 3,
2005        PP_mustSupplyOldPassword = 4,
2006        PP_insufficientPasswordQuality = 5,
2007        PP_passwordTooShort = 6,
2008        PP_passwordTooYoung = 7,
2009        PP_passwordInHistory = 8,
2010        PP_noError = 65535
2011 } LDAPPasswordPolicyError;
2012
2013 LDAP_F( int )
2014 ldap_create_passwordpolicy_control LDAP_P((
2015         LDAP *ld,
2016         LDAPControl **ctrlp ));
2017
2018 LDAP_F( int )
2019 ldap_parse_passwordpolicy_control LDAP_P((
2020         LDAP *ld,
2021         LDAPControl *ctrl,
2022         ber_int_t *expirep,
2023         ber_int_t *gracep,
2024         LDAPPasswordPolicyError *errorp ));
2025
2026 LDAP_F( const char * )
2027 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2028 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2029
2030 /*
2031  * LDAP Dynamic Directory Services Refresh RFC2589
2032  *      in dds.c
2033  */
2034 #define LDAP_API_FEATURE_REFRESH 1000
2035
2036 LDAP_F( int )
2037 ldap_parse_refresh LDAP_P((
2038         LDAP *ld,
2039         LDAPMessage *res,
2040         ber_int_t *newttl ));
2041
2042 LDAP_F( int )
2043 ldap_refresh LDAP_P(( LDAP *ld,
2044         struct berval   *dn,
2045         ber_int_t ttl,
2046         LDAPControl             **sctrls,
2047         LDAPControl             **cctrls,
2048         int                             *msgidp ));
2049
2050 LDAP_F( int )
2051 ldap_refresh_s LDAP_P((
2052         LDAP *ld,
2053         struct berval   *dn,
2054         ber_int_t ttl,
2055         ber_int_t *newttl,
2056         LDAPControl **sctrls,
2057         LDAPControl **cctrls ));
2058
2059 LDAP_END_DECL
2060 #endif /* _LDAP_H */