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