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