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