git.sur5r.net Git - openldap/blob - include/ldap.h

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