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