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