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"                  /* RFC TBD */
 213 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.1.13.1"                /* RFC TBD */
 214 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.1.13.2"                /* RFC TBD */
 215
 216 /*  standard track - not implemented in slapd(8) */
 217 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
 218 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
 219
 220 /*      non-standard track controls */
 221 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"   /* RFC 2696 */
 222
 223 /* Password policy Controls *//* work in progress */
 224 /* ITS#3458: released; disabled by default */
 225 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST      "1.3.6.1.4.1.42.2.27.8.5.1"
 226 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE     "1.3.6.1.4.1.42.2.27.8.5.1"
 227
 228 /* various works in progress */
 229 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
 230 #define LDAP_CONTROL_NO_SUBORDINATES    "1.3.6.1.4.1.4203.666.5.11"
 231 #define LDAP_CONTROL_MANAGEDIT                  "1.3.6.1.4.1.4203.666.5.12"
 232 #define LDAP_CONTROL_SLURP                              "1.3.6.1.4.1.4203.666.5.13"
 233 #define LDAP_CONTROL_VALSORT                    "1.3.6.1.4.1.4203.666.5.14"
 234
 235 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
 236 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
 237 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
 238 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
 239 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
 240 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
 241
 242 #define LDAP_SYNC_NONE                                  0x00
 243 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 244 #define LDAP_SYNC_RESERVED                              0x02
 245 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 246
 247 #define LDAP_SYNC_REFRESH_PRESENTS              0
 248 #define LDAP_SYNC_REFRESH_DELETES               1
 249
 250 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 251 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 252 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 253 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 254
 255 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 256 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 257 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 258 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 259
 260 #define LDAP_SYNC_PRESENT                               0
 261 #define LDAP_SYNC_ADD                                   1
 262 #define LDAP_SYNC_MODIFY                                2
 263 #define LDAP_SYNC_DELETE                                3
 264
 265 /* LDAP Chaining Behavior Control *//* work in progress */
 266 /* <draft-sermersheim-ldap-chaining>;
 267  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
 268 #ifdef LDAP_DEVEL
 269 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR        "1.3.6.1.4.1.4203.666.11.3"
 270
 271 #define LDAP_CHAINING_PREFERRED                         0
 272 #define LDAP_CHAINING_REQUIRED                          1
 273 #define LDAP_REFERRALS_PREFERRED                        2
 274 #define LDAP_REFERRALS_REQUIRED                         3
 275 #endif
 276
 277 /* MS Active Directory controls (for compatibility) */
 278 #define LDAP_CONTROL_X_INCREMENTAL_VALUES       "1.2.840.113556.1.4.802"
 279 #define LDAP_CONTROL_X_DOMAIN_SCOPE                     "1.2.840.113556.1.4.1339"
 280 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
 281 #define LDAP_CONTROL_X_SEARCH_OPTIONS           "1.2.840.113556.1.4.1340"
 282 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
 283 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
 284
 285 /* MS Active Directory controls - not implemented in slapd(8) */
 286 #define LDAP_CONTROL_X_TREE_DELETE              "1.2.840.113556.1.4.805"
 287 #define LDAP_CONTROL_X_EXTENDED_DN              "1.2.840.113556.1.4.529"
 288
 289 /* various expired works */
 290 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
 291 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 292 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 293 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 294 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 295
 296 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
 297 #define LDAP_CONTROL_PERSIST_REQUEST                            "2.16.840.1.113730.3.4.3"
 298 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE        "2.16.840.1.113730.3.4.7"
 299 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_ADD           0x1
 300 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_DELETE        0x2
 301 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_MODIFY        0x4
 302 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_RENAME        0x8
 303
 304 /* LDAP VLV *//* not implemented in slapd(8) */
 305 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 306 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 307
 308
 309 /* LDAP Unsolicited Notifications */
 310 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
 311 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 312
 313 /* LDAP Extended Operations */
 314 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
 315
 316 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 317 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 318 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 319 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 320 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 321
 322 #define LDAP_EXOP_CANCEL                "1.3.6.1.1.8"                           /* RFC 3909 */
 323 #define LDAP_EXOP_X_CANCEL              LDAP_EXOP_CANCEL
 324
 325 /* various works in progress */
 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_BASE                 ((ber_int_t) 0x0000)
 478 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
 479 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
 480 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
 481 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
 482 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
 483 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
 484 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
 485 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
 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
 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 /* Assertion control (122) */
 575 #define LDAP_ASSERTION_FAILED           0x7A
 576
 577
 578 /* Experimental result codes */
 579 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
 580
 581 /* LDAP Sync (4096) */
 582 #define LDAP_SYNC_REFRESH_REQUIRED              0x1000
 583
 584
 585 /* Private Use result codes */
 586 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
 587
 588 #define LDAP_X_SYNC_REFRESH_REQUIRED    0x4100 /* defunct */
 589 #define LDAP_X_ASSERTION_FAILED                 0x410f /* defunct */
 590
 591 /* for the LDAP No-Op control */
 592 #define LDAP_X_NO_OPERATION                             0x410e
 593
 594 /* for the Chaining Behavior control (consecutive result codes requested;
 595  * see <draft-sermersheim-ldap-chaining> ) */
 596 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
 597 #define LDAP_X_NO_REFERRALS_FOUND               0x4110
 598 #define LDAP_X_CANNOT_CHAIN                             0x4111
 599 #endif
 600
 601
 602 /* API Error Codes
 603  *
 604  * Based on draft-ietf-ldap-c-api-xx
 605  * but with new negative code values
 606  */
 607 #define LDAP_API_ERROR(n)               ((n)<0)
 608 #define LDAP_API_RESULT(n)              ((n)<=0)
 609
 610 #define LDAP_SERVER_DOWN                                (-1)
 611 #define LDAP_LOCAL_ERROR                                (-2)
 612 #define LDAP_ENCODING_ERROR                             (-3)
 613 #define LDAP_DECODING_ERROR                             (-4)
 614 #define LDAP_TIMEOUT                                    (-5)
 615 #define LDAP_AUTH_UNKNOWN                               (-6)
 616 #define LDAP_FILTER_ERROR                               (-7)
 617 #define LDAP_USER_CANCELLED                             (-8)
 618 #define LDAP_PARAM_ERROR                                (-9)
 619 #define LDAP_NO_MEMORY                                  (-10)
 620 #define LDAP_CONNECT_ERROR                              (-11)
 621 #define LDAP_NOT_SUPPORTED                              (-12)
 622 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 623 #define LDAP_NO_RESULTS_RETURNED                (-14)
 624 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)   /* Obsolete */
 625 #define LDAP_CLIENT_LOOP                                (-16)
 626 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 627
 628
 629 /*
 630  * This structure represents both ldap messages and ldap responses.
 631  * These are really the same, except in the case of search responses,
 632  * where a response has multiple messages.
 633  */
 634
 635 typedef struct ldapmsg LDAPMessage;
 636
 637 /* for modifications */
 638 typedef struct ldapmod {
 639         int             mod_op;
 640
 641 #define LDAP_MOD_OP                     (0x0007)
 642 #define LDAP_MOD_ADD            (0x0000)
 643 #define LDAP_MOD_DELETE         (0x0001)
 644 #define LDAP_MOD_REPLACE        (0x0002)
 645 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 646 #define LDAP_MOD_BVALUES        (0x0080)
 647 /* IMPORTANT: do not use code 0x1000 (or above),
 648  * it is used internally by the backends!
 649  * (see ldap/servers/slapd/slap.h)
 650  */
 651
 652         char            *mod_type;
 653         union mod_vals_u {
 654                 char            **modv_strvals;
 655                 struct berval   **modv_bvals;
 656         } mod_vals;
 657 #define mod_values      mod_vals.modv_strvals
 658 #define mod_bvalues     mod_vals.modv_bvals
 659 } LDAPMod;
 660
 661 /*
 662  * structure representing an ldap session which can
 663  * encompass connections to multiple servers (in the
 664  * face of referrals).
 665  */
 666 typedef struct ldap LDAP;
 667
 668 #define LDAP_DEREF_NEVER                0x00
 669 #define LDAP_DEREF_SEARCHING    0x01
 670 #define LDAP_DEREF_FINDING              0x02
 671 #define LDAP_DEREF_ALWAYS               0x03
 672
 673 #define LDAP_NO_LIMIT                   0
 674
 675 /* how many messages to retrieve results for */
 676 #define LDAP_MSG_ONE                    0x00
 677 #define LDAP_MSG_ALL                    0x01
 678 #define LDAP_MSG_RECEIVED               0x02
 679
 680 /*
 681  * types for ldap URL handling
 682  */
 683 typedef struct ldap_url_desc {
 684         struct ldap_url_desc *lud_next;
 685         char    *lud_scheme;
 686         char    *lud_host;
 687         int             lud_port;
 688         char    *lud_dn;
 689         char    **lud_attrs;
 690         int             lud_scope;
 691         char    *lud_filter;
 692         char    **lud_exts;
 693         int             lud_crit_exts;
 694 } LDAPURLDesc;
 695
 696 #define LDAP_URL_SUCCESS                0x00    /* Success */
 697 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 698 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 699
 700 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 701 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 702 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 703 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 704 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 705 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 706 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 707 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 708
 709 /*
 710  * The API draft spec says we should declare (or cause to be declared)
 711  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 712  */
 713 struct timeval;
 714
 715 /*
 716  * in options.c:
 717  */
 718 LDAP_F( int )
 719 ldap_get_option LDAP_P((
 720         LDAP *ld,
 721         int option,
 722         void *outvalue));
 723
 724 LDAP_F( int )
 725 ldap_set_option LDAP_P((
 726         LDAP *ld,
 727         int option,
 728         LDAP_CONST void *invalue));
 729
 730 /* V3 REBIND Function Callback Prototype */
 731 typedef int (LDAP_REBIND_PROC) LDAP_P((
 732         LDAP *ld, LDAP_CONST char *url,
 733         ber_tag_t request, ber_int_t msgid,
 734         void *params ));
 735
 736 LDAP_F( int )
 737 ldap_set_rebind_proc LDAP_P((
 738         LDAP *ld,
 739         LDAP_REBIND_PROC *rebind_proc,
 740         void *params ));
 741
 742 /* V3 referral selection Function Callback Prototype */
 743 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
 744         LDAP *ld, char ***refsp, int *cntp,
 745         void *params ));
 746
 747 LDAP_F( int )
 748 ldap_set_nextref_proc LDAP_P((
 749         LDAP *ld,
 750         LDAP_NEXTREF_PROC *nextref_proc,
 751         void *params ));
 752
 753 /*
 754  * in controls.c:
 755  */
 756 LDAP_F( int )
 757 ldap_create_control LDAP_P((
 758         LDAP_CONST char *requestOID,
 759         BerElement *ber,
 760         int iscritical,
 761         LDAPControl **ctrlp ));
 762
 763 LDAP_F( LDAPControl * )
 764 ldap_find_control LDAP_P((
 765         LDAP_CONST char *oid,
 766         LDAPControl **ctrls ));
 767
 768 LDAP_F( void )
 769 ldap_control_free LDAP_P((
 770         LDAPControl *ctrl ));
 771
 772 LDAP_F( void )
 773 ldap_controls_free LDAP_P((
 774         LDAPControl **ctrls ));
 775
 776 /*
 777  * in dnssrv.c:
 778  */
 779 LDAP_F( int )
 780 ldap_domain2dn LDAP_P((
 781         LDAP_CONST char* domain,
 782         char** dn ));
 783
 784 LDAP_F( int )
 785 ldap_dn2domain LDAP_P((
 786         LDAP_CONST char* dn,
 787         char** domain ));
 788
 789 LDAP_F( int )
 790 ldap_domain2hostlist LDAP_P((
 791         LDAP_CONST char *domain,
 792         char** hostlist ));
 793
 794 /*
 795  * in extended.c:
 796  */
 797 LDAP_F( int )
 798 ldap_extended_operation LDAP_P((
 799         LDAP                    *ld,
 800         LDAP_CONST char *reqoid,
 801         struct berval   *reqdata,
 802         LDAPControl             **serverctrls,
 803         LDAPControl             **clientctrls,
 804         int                             *msgidp ));
 805
 806 LDAP_F( int )
 807 ldap_extended_operation_s LDAP_P((
 808         LDAP                    *ld,
 809         LDAP_CONST char *reqoid,
 810         struct berval   *reqdata,
 811         LDAPControl             **serverctrls,
 812         LDAPControl             **clientctrls,
 813         char                    **retoidp,
 814         struct berval   **retdatap ));
 815
 816 LDAP_F( int )
 817 ldap_parse_extended_result LDAP_P((
 818         LDAP                    *ld,
 819         LDAPMessage             *res,
 820         char                    **retoidp,
 821         struct berval   **retdatap,
 822         int                             freeit ));
 823
 824 LDAP_F( int )
 825 ldap_parse_intermediate LDAP_P((
 826         LDAP                    *ld,
 827         LDAPMessage             *res,
 828         char                    **retoidp,
 829         struct berval   **retdatap,
 830         LDAPControl             ***serverctrls,
 831         int                             freeit ));
 832
 833 /*
 834  * in groupings.c:
 835  */
 836 #ifdef LDAP_EXOP_GROUPING_CREATE
 837
 838 LDAP_F( int )
 839 ldap_grouping_create LDAP_P((
 840         LDAP                    *ld,
 841         LDAP_CONST char *grpoid,
 842         struct berval   *grpdata,
 843         LDAPControl             **serverctrls,
 844         LDAPControl             **clientctrls,
 845         int                             *msgidp ));
 846
 847 LDAP_F( int )
 848 ldap_grouping_create_s LDAP_P((
 849         LDAP                    *ld,
 850         LDAP_CONST char *grpoid,
 851         struct berval   *grpdata,
 852         LDAPControl             **serverctrls,
 853         LDAPControl             **clientctrls,
 854         struct berval   **retgrpcookiep,
 855         struct berval   **retgrpdatap ));
 856
 857 LDAP_F( int )
 858 ldap_parse_grouping_create_result LDAP_P((
 859         LDAP                    *ld,
 860         LDAPMessage             *res,
 861         struct berval   **retgrpcookiep,
 862         struct berval   **retgrpdatap,
 863         LDAPControl             ***serverctrls,
 864         int                             freeit ));
 865
 866 LDAP_F( int )
 867 ldap_grouping_end LDAP_P((
 868         LDAP                    *ld,
 869         LDAP_CONST char *grpoid,
 870         struct berval   *grpdata,
 871         LDAPControl             **serverctrls,
 872         LDAPControl             **clientctrls,
 873         int                             *msgidp ));
 874
 875 LDAP_F( int )
 876 ldap_grouping_end_s LDAP_P((
 877         LDAP                    *ld,
 878         LDAP_CONST char *grpoid,
 879         struct berval   *grpdata,
 880         LDAPControl             **serverctrls,
 881         LDAPControl             **clientctrls,
 882         struct berval   **retgrpdatap ));
 883
 884 LDAP_F( int )
 885 ldap_parse_grouping_end_result LDAP_P((
 886         LDAP                    *ld,
 887         LDAPMessage             *res,
 888         struct berval   **retgrpdatap,
 889         LDAPControl             ***serverctrls,
 890         int                             freeit ));
 891
 892 LDAP_F( int )
 893 ldap_grouping_action_operation LDAP_P((
 894         LDAP                    *ld,
 895         LDAP_CONST char *grpoid,
 896         struct berval   *grpdata,
 897         LDAPControl             **serverctrls,
 898         LDAPControl             **clientctrls,
 899         int                             *msgidp ));
 900
 901 LDAP_F( int )
 902 ldap_grouping_action_operation_s LDAP_P((
 903         LDAP                    *ld,
 904         LDAP_CONST char *grpoid,
 905         struct berval   *grpdata,
 906         LDAPControl             **serverctrls,
 907         LDAPControl             **clientctrls,
 908         struct berval   **retgrpcookiep,
 909         struct berval   **retgrpdatap ));
 910
 911 LDAP_F( int )
 912 ldap_parse_grouping_action_result LDAP_P((
 913         LDAP                    *ld,
 914         LDAPMessage             *res,
 915         struct berval   **retgrpcookiep,
 916         struct berval   **retgrpdatap,
 917         LDAPControl             ***serverctrls,
 918         int                             freeit ));
 919
 920 LDAP_F( int )
 921 ldap_parse_grouping_end_notice LDAP_P((
 922         LDAP                    *ld,
 923         LDAPMessage             *res,
 924         struct berval   **retdatap,
 925         struct berval   **retgrpcookiep,
 926         struct berval   **retgrpdatap,
 927         int                             freeit ));
 928
 929 LDAP_F( int )
 930 ldap_parse_grouping_info_notice LDAP_P((
 931         LDAP                    *ld,
 932         LDAPMessage             *res,
 933         struct berval   **retdatap,
 934         struct berval   **retgrpcookiep,
 935         struct berval   **retgrpdatap,
 936         int                             freeit ));
 937 #endif
 938
 939 /*
 940  * in abandon.c:
 941  */
 942 LDAP_F( int )
 943 ldap_abandon_ext LDAP_P((
 944         LDAP                    *ld,
 945         int                             msgid,
 946         LDAPControl             **serverctrls,
 947         LDAPControl             **clientctrls ));
 948
 949 #if LDAP_DEPRECATED
 950 LDAP_F( int )
 951 ldap_abandon LDAP_P((   /* deprecated */
 952         LDAP *ld,
 953         int msgid ));
 954 #endif
 955
 956
 957 /*
 958  * in add.c:
 959  */
 960 LDAP_F( int )
 961 ldap_add_ext LDAP_P((
 962         LDAP                    *ld,
 963         LDAP_CONST char *dn,
 964         LDAPMod                 **attrs,
 965         LDAPControl             **serverctrls,
 966         LDAPControl             **clientctrls,
 967         int                     *msgidp ));
 968
 969 LDAP_F( int )
 970 ldap_add_ext_s LDAP_P((
 971         LDAP                    *ld,
 972         LDAP_CONST char *dn,
 973         LDAPMod                 **attrs,
 974         LDAPControl             **serverctrls,
 975         LDAPControl             **clientctrls ));
 976
 977 #if LDAP_DEPRECATED
 978 LDAP_F( int )
 979 ldap_add LDAP_P((       /* deprecated */
 980         LDAP *ld,
 981         LDAP_CONST char *dn,
 982         LDAPMod **attrs ));
 983
 984 LDAP_F( int )
 985 ldap_add_s LDAP_P((     /* deprecated */
 986         LDAP *ld,
 987         LDAP_CONST char *dn,
 988         LDAPMod **attrs ));
 989 #endif
 990
 991
 992 /*
 993  * in sasl.c:
 994  */
 995 LDAP_F( int )
 996 ldap_sasl_bind LDAP_P((
 997         LDAP                    *ld,
 998         LDAP_CONST char *dn,
 999         LDAP_CONST char *mechanism,
1000         struct berval   *cred,
1001         LDAPControl             **serverctrls,
1002         LDAPControl             **clientctrls,
1003         int                             *msgidp ));
1004
1005 /* Interaction flags (should be passed about in a control)
1006  *  Automatic (default): use defaults, prompt otherwise
1007  *  Interactive: prompt always
1008  *  Quiet: never prompt
1009  */
1010 #define LDAP_SASL_AUTOMATIC             0U
1011 #define LDAP_SASL_INTERACTIVE   1U
1012 #define LDAP_SASL_QUIET                 2U
1013
1014 /*
1015  * V3 SASL Interaction Function Callback Prototype
1016  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
1017  *  should likely passed in a control (and provided controls)
1018  */
1019 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1020         LDAP *ld, unsigned flags, void* defaults, void *interact ));
1021
1022 LDAP_F( int )
1023 ldap_sasl_interactive_bind_s LDAP_P((
1024         LDAP *ld,
1025         LDAP_CONST char *dn, /* usually NULL */
1026         LDAP_CONST char *saslMechanism,
1027         LDAPControl **serverControls,
1028         LDAPControl **clientControls,
1029
1030         /* should be client controls */
1031         unsigned flags,
1032         LDAP_SASL_INTERACT_PROC *proc,
1033         void *defaults ));
1034
1035 LDAP_F( int )
1036 ldap_sasl_bind_s LDAP_P((
1037         LDAP                    *ld,
1038         LDAP_CONST char *dn,
1039         LDAP_CONST char *mechanism,
1040         struct berval   *cred,
1041         LDAPControl             **serverctrls,
1042         LDAPControl             **clientctrls,
1043         struct berval   **servercredp ));
1044
1045 LDAP_F( int )
1046 ldap_parse_sasl_bind_result LDAP_P((
1047         LDAP                    *ld,
1048         LDAPMessage             *res,
1049         struct berval   **servercredp,
1050         int                             freeit ));
1051
1052 #if LDAP_DEPRECATED
1053 /*
1054  * in bind.c:
1055  *      (deprecated)
1056  */
1057 LDAP_F( int )
1058 ldap_bind LDAP_P((      /* deprecated */
1059         LDAP *ld,
1060         LDAP_CONST char *who,
1061         LDAP_CONST char *passwd,
1062         int authmethod ));
1063
1064 LDAP_F( int )
1065 ldap_bind_s LDAP_P((    /* deprecated */
1066         LDAP *ld,
1067         LDAP_CONST char *who,
1068         LDAP_CONST char *cred,
1069         int authmethod ));
1070
1071 /*
1072  * in sbind.c:
1073  */
1074 LDAP_F( int )
1075 ldap_simple_bind LDAP_P(( /* deprecated */
1076         LDAP *ld,
1077         LDAP_CONST char *who,
1078         LDAP_CONST char *passwd ));
1079
1080 LDAP_F( int )
1081 ldap_simple_bind_s LDAP_P(( /* deprecated */
1082         LDAP *ld,
1083         LDAP_CONST char *who,
1084         LDAP_CONST char *passwd ));
1085
1086
1087 /*
1088  * in kbind.c:
1089  *      (deprecated)
1090  */
1091 LDAP_F( int )
1092 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1093         LDAP *ld,
1094         LDAP_CONST char *who ));
1095
1096 LDAP_F( int )
1097 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1098         LDAP *ld,
1099         LDAP_CONST char *who ));
1100
1101 LDAP_F( int )
1102 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1103         LDAP *ld,
1104         LDAP_CONST char *who ));
1105
1106 LDAP_F( int )
1107 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1108         LDAP *ld,
1109         LDAP_CONST char *who ));
1110
1111 LDAP_F( int )
1112 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1113         LDAP *ld,
1114         LDAP_CONST char *who ));
1115 #endif
1116
1117
1118 /*
1119  * in compare.c:
1120  */
1121 LDAP_F( int )
1122 ldap_compare_ext LDAP_P((
1123         LDAP                    *ld,
1124         LDAP_CONST char *dn,
1125         LDAP_CONST char *attr,
1126         struct berval   *bvalue,
1127         LDAPControl             **serverctrls,
1128         LDAPControl             **clientctrls,
1129         int                     *msgidp ));
1130
1131 LDAP_F( int )
1132 ldap_compare_ext_s LDAP_P((
1133         LDAP                    *ld,
1134         LDAP_CONST char *dn,
1135         LDAP_CONST char *attr,
1136         struct berval   *bvalue,
1137         LDAPControl             **serverctrls,
1138         LDAPControl             **clientctrls ));
1139
1140 #if LDAP_DEPRECATED
1141 LDAP_F( int )
1142 ldap_compare LDAP_P((   /* deprecated */
1143         LDAP *ld,
1144         LDAP_CONST char *dn,
1145         LDAP_CONST char *attr,
1146         LDAP_CONST char *value ));
1147
1148 LDAP_F( int )
1149 ldap_compare_s LDAP_P(( /* deprecated */
1150         LDAP *ld,
1151         LDAP_CONST char *dn,
1152         LDAP_CONST char *attr,
1153         LDAP_CONST char *value ));
1154 #endif
1155
1156
1157 /*
1158  * in delete.c:
1159  */
1160 LDAP_F( int )
1161 ldap_delete_ext LDAP_P((
1162         LDAP                    *ld,
1163         LDAP_CONST char *dn,
1164         LDAPControl             **serverctrls,
1165         LDAPControl             **clientctrls,
1166         int                     *msgidp ));
1167
1168 LDAP_F( int )
1169 ldap_delete_ext_s LDAP_P((
1170         LDAP                    *ld,
1171         LDAP_CONST char *dn,
1172         LDAPControl             **serverctrls,
1173         LDAPControl             **clientctrls ));
1174
1175 #if LDAP_DEPRECATED
1176 LDAP_F( int )
1177 ldap_delete LDAP_P((    /* deprecated */
1178         LDAP *ld,
1179         LDAP_CONST char *dn ));
1180
1181 LDAP_F( int )
1182 ldap_delete_s LDAP_P((  /* deprecated */
1183         LDAP *ld,
1184         LDAP_CONST char *dn ));
1185 #endif
1186
1187
1188 /*
1189  * in error.c:
1190  */
1191 LDAP_F( int )
1192 ldap_parse_result LDAP_P((
1193         LDAP                    *ld,
1194         LDAPMessage             *res,
1195         int                             *errcodep,
1196         char                    **matcheddnp,
1197         char                    **errmsgp,
1198         char                    ***referralsp,
1199         LDAPControl             ***serverctrls,
1200         int                             freeit ));
1201
1202 LDAP_F( char * )
1203 ldap_err2string LDAP_P((
1204         int err ));
1205
1206 #if LDAP_DEPRECATED
1207 LDAP_F( int )
1208 ldap_result2error LDAP_P((      /* deprecated */
1209         LDAP *ld,
1210         LDAPMessage *r,
1211         int freeit ));
1212
1213 LDAP_F( void )
1214 ldap_perror LDAP_P((    /* deprecated */
1215         LDAP *ld,
1216         LDAP_CONST char *s ));
1217 #endif
1218
1219
1220 /*
1221  * in modify.c:
1222  */
1223 LDAP_F( int )
1224 ldap_modify_ext LDAP_P((
1225         LDAP                    *ld,
1226         LDAP_CONST char *dn,
1227         LDAPMod                 **mods,
1228         LDAPControl             **serverctrls,
1229         LDAPControl             **clientctrls,
1230         int                     *msgidp ));
1231
1232 LDAP_F( int )
1233 ldap_modify_ext_s LDAP_P((
1234         LDAP                    *ld,
1235         LDAP_CONST char *dn,
1236         LDAPMod                 **mods,
1237         LDAPControl             **serverctrls,
1238         LDAPControl             **clientctrls ));
1239
1240 #if LDAP_DEPRECATED
1241 LDAP_F( int )
1242 ldap_modify LDAP_P((    /* deprecated */
1243         LDAP *ld,
1244         LDAP_CONST char *dn,
1245         LDAPMod **mods ));
1246
1247 LDAP_F( int )
1248 ldap_modify_s LDAP_P((  /* deprecated */
1249         LDAP *ld,
1250         LDAP_CONST char *dn,
1251         LDAPMod **mods ));
1252 #endif
1253
1254
1255 /*
1256  * in modrdn.c:
1257  */
1258 LDAP_F( int )
1259 ldap_rename LDAP_P((
1260         LDAP *ld,
1261         LDAP_CONST char *dn,
1262         LDAP_CONST char *newrdn,
1263         LDAP_CONST char *newSuperior,
1264         int deleteoldrdn,
1265         LDAPControl **sctrls,
1266         LDAPControl **cctrls,
1267         int *msgidp ));
1268
1269 LDAP_F( int )
1270 ldap_rename_s LDAP_P((
1271         LDAP *ld,
1272         LDAP_CONST char *dn,
1273         LDAP_CONST char *newrdn,
1274         LDAP_CONST char *newSuperior,
1275         int deleteoldrdn,
1276         LDAPControl **sctrls,
1277         LDAPControl **cctrls ));
1278
1279 #if LDAP_DEPRECATED
1280 LDAP_F( int )
1281 ldap_rename2 LDAP_P((   /* deprecated */
1282         LDAP *ld,
1283         LDAP_CONST char *dn,
1284         LDAP_CONST char *newrdn,
1285         LDAP_CONST char *newSuperior,
1286         int deleteoldrdn ));
1287
1288 LDAP_F( int )
1289 ldap_rename2_s LDAP_P(( /* deprecated */
1290         LDAP *ld,
1291         LDAP_CONST char *dn,
1292         LDAP_CONST char *newrdn,
1293         LDAP_CONST char *newSuperior,
1294         int deleteoldrdn ));
1295
1296 LDAP_F( int )
1297 ldap_modrdn LDAP_P((    /* deprecated */
1298         LDAP *ld,
1299         LDAP_CONST char *dn,
1300         LDAP_CONST char *newrdn ));
1301
1302 LDAP_F( int )
1303 ldap_modrdn_s LDAP_P((  /* deprecated */
1304         LDAP *ld,
1305         LDAP_CONST char *dn,
1306         LDAP_CONST char *newrdn ));
1307
1308 LDAP_F( int )
1309 ldap_modrdn2 LDAP_P((   /* deprecated */
1310         LDAP *ld,
1311         LDAP_CONST char *dn,
1312         LDAP_CONST char *newrdn,
1313         int deleteoldrdn ));
1314
1315 LDAP_F( int )
1316 ldap_modrdn2_s LDAP_P(( /* deprecated */
1317         LDAP *ld,
1318         LDAP_CONST char *dn,
1319         LDAP_CONST char *newrdn,
1320         int deleteoldrdn));
1321 #endif
1322
1323
1324 /*
1325  * in open.c:
1326  */
1327 #if LDAP_DEPRECATED
1328 LDAP_F( LDAP * )
1329 ldap_init LDAP_P(( /* deprecated */
1330         LDAP_CONST char *host,
1331         int port ));
1332
1333 LDAP_F( LDAP * )
1334 ldap_open LDAP_P((      /* deprecated */
1335         LDAP_CONST char *host,
1336         int port ));
1337 #endif
1338
1339 LDAP_F( int )
1340 ldap_create LDAP_P((
1341         LDAP **ldp ));
1342
1343 LDAP_F( int )
1344 ldap_initialize LDAP_P((
1345         LDAP **ldp,
1346         LDAP_CONST char *url ));
1347
1348 /*
1349  * in tls.c
1350  */
1351
1352 LDAP_F( int )
1353 ldap_tls_inplace LDAP_P((
1354         LDAP *ld ));
1355
1356 LDAP_F( int )
1357 ldap_start_tls LDAP_P((
1358         LDAP *ld,
1359         LDAPControl **serverctrls,
1360         LDAPControl **clientctrls,
1361         int *msgidp ));
1362
1363 LDAP_F( int )
1364 ldap_install_tls LDAP_P((
1365         LDAP *ld ));
1366
1367 LDAP_F( int )
1368 ldap_start_tls_s LDAP_P((
1369         LDAP *ld,
1370         LDAPControl **serverctrls,
1371         LDAPControl **clientctrls ));
1372
1373 /*
1374  * in messages.c:
1375  */
1376 LDAP_F( LDAPMessage * )
1377 ldap_first_message LDAP_P((
1378         LDAP *ld,
1379         LDAPMessage *chain ));
1380
1381 LDAP_F( LDAPMessage * )
1382 ldap_next_message LDAP_P((
1383         LDAP *ld,
1384         LDAPMessage *msg ));
1385
1386 LDAP_F( int )
1387 ldap_count_messages LDAP_P((
1388         LDAP *ld,
1389         LDAPMessage *chain ));
1390
1391 /*
1392  * in references.c:
1393  */
1394 LDAP_F( LDAPMessage * )
1395 ldap_first_reference LDAP_P((
1396         LDAP *ld,
1397         LDAPMessage *chain ));
1398
1399 LDAP_F( LDAPMessage * )
1400 ldap_next_reference LDAP_P((
1401         LDAP *ld,
1402         LDAPMessage *ref ));
1403
1404 LDAP_F( int )
1405 ldap_count_references LDAP_P((
1406         LDAP *ld,
1407         LDAPMessage *chain ));
1408
1409 LDAP_F( int )
1410 ldap_parse_reference LDAP_P((
1411         LDAP                    *ld,
1412         LDAPMessage             *ref,
1413         char                    ***referralsp,
1414         LDAPControl             ***serverctrls,
1415         int                             freeit));
1416
1417
1418 /*
1419  * in getentry.c:
1420  */
1421 LDAP_F( LDAPMessage * )
1422 ldap_first_entry LDAP_P((
1423         LDAP *ld,
1424         LDAPMessage *chain ));
1425
1426 LDAP_F( LDAPMessage * )
1427 ldap_next_entry LDAP_P((
1428         LDAP *ld,
1429         LDAPMessage *entry ));
1430
1431 LDAP_F( int )
1432 ldap_count_entries LDAP_P((
1433         LDAP *ld,
1434         LDAPMessage *chain ));
1435
1436 LDAP_F( int )
1437 ldap_get_entry_controls LDAP_P((
1438         LDAP                    *ld,
1439         LDAPMessage             *entry,
1440         LDAPControl             ***serverctrls));
1441
1442
1443 /*
1444  * in addentry.c
1445  */
1446 LDAP_F( LDAPMessage * )
1447 ldap_delete_result_entry LDAP_P((
1448         LDAPMessage **list,
1449         LDAPMessage *e ));
1450
1451 LDAP_F( void )
1452 ldap_add_result_entry LDAP_P((
1453         LDAPMessage **list,
1454         LDAPMessage *e ));
1455
1456
1457 /*
1458  * in getdn.c
1459  */
1460 LDAP_F( char * )
1461 ldap_get_dn LDAP_P((
1462         LDAP *ld,
1463         LDAPMessage *entry ));
1464
1465 typedef struct ldap_ava {
1466         struct berval la_attr;
1467         struct berval la_value;
1468         unsigned la_flags;
1469 #define LDAP_AVA_NULL                           0x0000U
1470 #define LDAP_AVA_STRING                         0x0001U
1471 #define LDAP_AVA_BINARY                         0x0002U
1472 #define LDAP_AVA_NONPRINTABLE           0x0004U
1473 #define LDAP_AVA_FREE_ATTR                      0x0010U
1474 #define LDAP_AVA_FREE_VALUE                     0x0020U
1475
1476         void *la_private;
1477 } LDAPAVA;
1478
1479 typedef LDAPAVA** LDAPRDN;
1480 typedef LDAPRDN* LDAPDN;
1481
1482 /* DN formats */
1483 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1484 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1485 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1486 #define LDAP_DN_FORMAT_DCE                      0x0030U
1487 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1488 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1489 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1490 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1491
1492 /* DN flags */
1493 #define LDAP_DN_PRETTY                          0x0100U
1494 #define LDAP_DN_SKIP                            0x0200U
1495 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1496 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1497 #define LDAP_DN_PEDANTIC                        0xF000U
1498
1499 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1500 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1501
1502 LDAP_F( int )
1503 ldap_bv2dn LDAP_P((
1504         struct berval *bv,
1505         LDAPDN *dn,
1506         unsigned flags ));
1507
1508 LDAP_F( int )
1509 ldap_str2dn LDAP_P((
1510         LDAP_CONST char *str,
1511         LDAPDN *dn,
1512         unsigned flags ));
1513
1514 LDAP_F( int )
1515 ldap_dn2bv LDAP_P((
1516         LDAPDN dn,
1517         struct berval *bv,
1518         unsigned flags ));
1519
1520 LDAP_F( int )
1521 ldap_dn2str LDAP_P((
1522         LDAPDN dn,
1523         char **str,
1524         unsigned flags ));
1525
1526 LDAP_F( int )
1527 ldap_bv2rdn LDAP_P((
1528         struct berval *bv,
1529         LDAPRDN *rdn,
1530         char **next,
1531         unsigned flags ));
1532
1533 LDAP_F( int )
1534 ldap_str2rdn LDAP_P((
1535         LDAP_CONST char *str,
1536         LDAPRDN *rdn,
1537         char **next,
1538         unsigned flags ));
1539
1540 LDAP_F( int )
1541 ldap_rdn2bv LDAP_P((
1542         LDAPRDN rdn,
1543         struct berval *bv,
1544         unsigned flags ));
1545
1546 LDAP_F( int )
1547 ldap_rdn2str LDAP_P((
1548         LDAPRDN rdn,
1549         char **str,
1550         unsigned flags ));
1551
1552 LDAP_F( int )
1553 ldap_dn_normalize LDAP_P((
1554         LDAP_CONST char *in, unsigned iflags,
1555         char **out, unsigned oflags ));
1556
1557 LDAP_F( char * )
1558 ldap_dn2ufn LDAP_P(( /* deprecated */
1559         LDAP_CONST char *dn ));
1560
1561 LDAP_F( char ** )
1562 ldap_explode_dn LDAP_P(( /* deprecated */
1563         LDAP_CONST char *dn,
1564         int notypes ));
1565
1566 LDAP_F( char ** )
1567 ldap_explode_rdn LDAP_P(( /* deprecated */
1568         LDAP_CONST char *rdn,
1569         int notypes ));
1570
1571 typedef int LDAPDN_rewrite_func
1572         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1573
1574 LDAP_F( int )
1575 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1576         LDAPDN_rewrite_func *func, unsigned flags ));
1577
1578 LDAP_F( char * )
1579 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1580
1581 LDAP_F( char * )
1582 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1583
1584 LDAP_F( char * )
1585 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1586
1587 LDAP_F( int )
1588 ldap_get_dn_ber LDAP_P((
1589         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1590
1591 LDAP_F( int )
1592 ldap_get_attribute_ber LDAP_P((
1593         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1594         struct berval **vals ));
1595
1596 /*
1597  * in getattr.c
1598  */
1599 LDAP_F( char * )
1600 ldap_first_attribute LDAP_P((
1601         LDAP *ld,
1602         LDAPMessage *entry,
1603         BerElement **ber ));
1604
1605 LDAP_F( char * )
1606 ldap_next_attribute LDAP_P((
1607         LDAP *ld,
1608         LDAPMessage *entry,
1609         BerElement *ber ));
1610
1611
1612 /*
1613  * in getvalues.c
1614  */
1615 LDAP_F( struct berval ** )
1616 ldap_get_values_len LDAP_P((
1617         LDAP *ld,
1618         LDAPMessage *entry,
1619         LDAP_CONST char *target ));
1620
1621 LDAP_F( int )
1622 ldap_count_values_len LDAP_P((
1623         struct berval **vals ));
1624
1625 LDAP_F( void )
1626 ldap_value_free_len LDAP_P((
1627         struct berval **vals ));
1628
1629 #if LDAP_DEPRECATED
1630 LDAP_F( char ** )
1631 ldap_get_values LDAP_P((        /* deprecated */
1632         LDAP *ld,
1633         LDAPMessage *entry,
1634         LDAP_CONST char *target ));
1635
1636 LDAP_F( int )
1637 ldap_count_values LDAP_P((      /* deprecated */
1638         char **vals ));
1639
1640 LDAP_F( void )
1641 ldap_value_free LDAP_P((        /* deprecated */
1642         char **vals ));
1643 #endif
1644
1645 /*
1646  * in result.c:
1647  */
1648 LDAP_F( int )
1649 ldap_result LDAP_P((
1650         LDAP *ld,
1651         int msgid,
1652         int all,
1653         struct timeval *timeout,
1654         LDAPMessage **result ));
1655
1656 LDAP_F( int )
1657 ldap_msgtype LDAP_P((
1658         LDAPMessage *lm ));
1659
1660 LDAP_F( int )
1661 ldap_msgid   LDAP_P((
1662         LDAPMessage *lm ));
1663
1664 LDAP_F( int )
1665 ldap_msgfree LDAP_P((
1666         LDAPMessage *lm ));
1667
1668 LDAP_F( int )
1669 ldap_msgdelete LDAP_P((
1670         LDAP *ld,
1671         int msgid ));
1672
1673
1674 /*
1675  * in search.c:
1676  */
1677 LDAP_F( int )
1678 ldap_bv2escaped_filter_value LDAP_P((
1679         struct berval *in,
1680         struct berval *out ));
1681
1682 LDAP_F( int )
1683 ldap_search_ext LDAP_P((
1684         LDAP                    *ld,
1685         LDAP_CONST char *base,
1686         int                             scope,
1687         LDAP_CONST char *filter,
1688         char                    **attrs,
1689         int                             attrsonly,
1690         LDAPControl             **serverctrls,
1691         LDAPControl             **clientctrls,
1692         struct timeval  *timeout,
1693         int                             sizelimit,
1694         int                             *msgidp ));
1695
1696 LDAP_F( int )
1697 ldap_search_ext_s LDAP_P((
1698         LDAP                    *ld,
1699         LDAP_CONST char *base,
1700         int                             scope,
1701         LDAP_CONST char *filter,
1702         char                    **attrs,
1703         int                             attrsonly,
1704         LDAPControl             **serverctrls,
1705         LDAPControl             **clientctrls,
1706         struct timeval  *timeout,
1707         int                             sizelimit,
1708         LDAPMessage             **res ));
1709
1710 #if LDAP_DEPRECATED
1711 LDAP_F( int )
1712 ldap_search LDAP_P((    /* deprecated */
1713         LDAP *ld,
1714         LDAP_CONST char *base,
1715         int scope,
1716         LDAP_CONST char *filter,
1717         char **attrs,
1718         int attrsonly ));
1719
1720 LDAP_F( int )
1721 ldap_search_s LDAP_P((  /* deprecated */
1722         LDAP *ld,
1723         LDAP_CONST char *base,
1724         int scope,
1725         LDAP_CONST char *filter,
1726         char **attrs,
1727         int attrsonly,
1728         LDAPMessage **res ));
1729
1730 LDAP_F( int )
1731 ldap_search_st LDAP_P(( /* deprecated */
1732         LDAP *ld,
1733         LDAP_CONST char *base,
1734         int scope,
1735         LDAP_CONST char *filter,
1736     char **attrs,
1737         int attrsonly,
1738         struct timeval *timeout,
1739         LDAPMessage **res ));
1740 #endif
1741
1742 /*
1743  * in unbind.c
1744  */
1745 LDAP_F( int )
1746 ldap_unbind_ext LDAP_P((
1747         LDAP                    *ld,
1748         LDAPControl             **serverctrls,
1749         LDAPControl             **clientctrls));
1750
1751 LDAP_F( int )
1752 ldap_unbind_ext_s LDAP_P((
1753         LDAP                    *ld,
1754         LDAPControl             **serverctrls,
1755         LDAPControl             **clientctrls));
1756
1757 #if LDAP_DEPRECATED
1758 LDAP_F( int )
1759 ldap_unbind LDAP_P(( /* deprecated */
1760         LDAP *ld ));
1761
1762 LDAP_F( int )
1763 ldap_unbind_s LDAP_P(( /* deprecated */
1764         LDAP *ld ));
1765 #endif
1766
1767 /*
1768  * in filter.c
1769  */
1770 LDAP_F( int )
1771 ldap_put_vrFilter LDAP_P((
1772         BerElement *ber,
1773         const char *vrf ));
1774
1775 /*
1776  * in free.c
1777  */
1778
1779 LDAP_F( void * )
1780 ldap_memalloc LDAP_P((
1781         ber_len_t s ));
1782
1783 LDAP_F( void * )
1784 ldap_memrealloc LDAP_P((
1785         void* p,
1786         ber_len_t s ));
1787
1788 LDAP_F( void * )
1789 ldap_memcalloc LDAP_P((
1790         ber_len_t n,
1791         ber_len_t s ));
1792
1793 LDAP_F( void )
1794 ldap_memfree LDAP_P((
1795         void* p ));
1796
1797 LDAP_F( void )
1798 ldap_memvfree LDAP_P((
1799         void** v ));
1800
1801 LDAP_F( char * )
1802 ldap_strdup LDAP_P((
1803         LDAP_CONST char * ));
1804
1805 LDAP_F( void )
1806 ldap_mods_free LDAP_P((
1807         LDAPMod **mods,
1808         int freemods ));
1809
1810
1811 #if LDAP_DEPRECATED
1812 /*
1813  * in sort.c (deprecated)
1814  */
1815 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1816         LDAP_CONST char *left,
1817         LDAP_CONST char *right ));
1818
1819 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1820         LDAP_CONST void *left,
1821         LDAP_CONST void *right ));
1822
1823 LDAP_F( int )   /* deprecated */
1824 ldap_sort_entries LDAP_P(( LDAP *ld,
1825         LDAPMessage **chain,
1826         LDAP_CONST char *attr,
1827         LDAP_SORT_AD_CMP_PROC *cmp ));
1828
1829 LDAP_F( int )   /* deprecated */
1830 ldap_sort_values LDAP_P((
1831         LDAP *ld,
1832         char **vals,
1833         LDAP_SORT_AV_CMP_PROC *cmp ));
1834
1835 LDAP_F( int ) /* deprecated */
1836 ldap_sort_strcasecmp LDAP_P((
1837         LDAP_CONST void *a,
1838         LDAP_CONST void *b ));
1839 #endif
1840
1841 /*
1842  * in url.c
1843  */
1844 LDAP_F( int )
1845 ldap_is_ldap_url LDAP_P((
1846         LDAP_CONST char *url ));
1847
1848 LDAP_F( int )
1849 ldap_is_ldaps_url LDAP_P((
1850         LDAP_CONST char *url ));
1851
1852 LDAP_F( int )
1853 ldap_is_ldapi_url LDAP_P((
1854         LDAP_CONST char *url ));
1855
1856 LDAP_F( int )
1857 ldap_url_parse LDAP_P((
1858         LDAP_CONST char *url,
1859         LDAPURLDesc **ludpp ));
1860
1861 LDAP_F( char * )
1862 ldap_url_desc2str LDAP_P((
1863         LDAPURLDesc *ludp ));
1864
1865 LDAP_F( void )
1866 ldap_free_urldesc LDAP_P((
1867         LDAPURLDesc *ludp ));
1868
1869
1870 /*
1871  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1872  *  in cancel.c
1873  */
1874 #define LDAP_API_FEATURE_CANCEL 1000
1875
1876 LDAP_F( int )
1877 ldap_cancel LDAP_P(( LDAP *ld,
1878         int cancelid,
1879         LDAPControl             **sctrls,
1880         LDAPControl             **cctrls,
1881         int                             *msgidp ));
1882
1883 LDAP_F( int )
1884 ldap_cancel_s LDAP_P(( LDAP *ld,
1885         int cancelid,
1886         LDAPControl **sctrl,
1887         LDAPControl **cctrl ));
1888
1889 /*
1890  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1891  *  in turn.c
1892  */
1893 #define LDAP_API_FEATURE_TURN 1000
1894
1895 LDAP_F( int )
1896 ldap_turn LDAP_P(( LDAP *ld,
1897         int mutual,
1898         LDAP_CONST char* identifier,
1899         LDAPControl             **sctrls,
1900         LDAPControl             **cctrls,
1901         int                             *msgidp ));
1902
1903 LDAP_F( int )
1904 ldap_turn_s LDAP_P(( LDAP *ld,
1905         int mutual,
1906         LDAP_CONST char* identifier,
1907         LDAPControl **sctrl,
1908         LDAPControl **cctrl ));
1909
1910 /*
1911  * LDAP Server Side Sort
1912  *      in sortctrl.c
1913  */
1914 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1915
1916 /* structure for a sort-key */
1917 typedef struct ldapsortkey {
1918         char *  attributeType;
1919         char *  orderingRule;
1920         int     reverseOrder;
1921 } LDAPSortKey;
1922
1923 LDAP_F( int )
1924 ldap_create_sort_keylist LDAP_P((
1925         LDAPSortKey ***sortKeyList,
1926         char        *keyString ));
1927
1928 LDAP_F( void )
1929 ldap_free_sort_keylist LDAP_P((
1930         LDAPSortKey **sortkeylist ));
1931
1932 LDAP_F( int )
1933 ldap_create_sort_control LDAP_P((
1934         LDAP *ld,
1935         LDAPSortKey **keyList,
1936         int ctl_iscritical,
1937         LDAPControl **ctrlp ));
1938
1939 LDAP_F( int )
1940 ldap_parse_sort_control LDAP_P((
1941         LDAP           *ld,
1942         LDAPControl    **ctrlp,
1943         unsigned long  *result,
1944         char           **attribute ));
1945
1946
1947 /*
1948  * LDAP Virtual List View
1949  *      in vlvctrl.c
1950  */
1951 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1952
1953 /* structure for virtual list */
1954 typedef struct ldapvlvinfo {
1955         int             ldvlv_version;
1956     unsigned long   ldvlv_before_count;
1957     unsigned long   ldvlv_after_count;
1958     unsigned long   ldvlv_offset;
1959     unsigned long   ldvlv_count;
1960     struct berval *     ldvlv_attrvalue;
1961     struct berval *     ldvlv_context;
1962     void *                      ldvlv_extradata;
1963 } LDAPVLVInfo;
1964
1965 LDAP_F( int )
1966 ldap_create_vlv_control LDAP_P((
1967         LDAP *ld,
1968         LDAPVLVInfo *ldvlistp,
1969         LDAPControl **ctrlp ));
1970
1971 LDAP_F( int )
1972 ldap_parse_vlv_control LDAP_P((
1973         LDAP          *ld,
1974         LDAPControl   **ctrls,
1975         unsigned long *target_posp,
1976         unsigned long *list_countp,
1977         struct berval **contextp,
1978         int           *errcodep ));
1979
1980 /*
1981  * LDAP Transactions
1982  *      in txn.c
1983  */
1984 #ifdef LDAP_GROUP_TRANSACTION
1985 LDAP_F( int )
1986 ldap_parse_txn_create LDAP_P((
1987         LDAP *ld,
1988         LDAPMessage *res,
1989         struct berval **cookie ));
1990
1991 LDAP_F( int )
1992 ldap_txn_create LDAP_P((
1993         LDAP *ld,
1994         LDAPControl             **sctrls,
1995         LDAPControl             **cctrls,
1996         int                             *msgidp ));
1997
1998 LDAP_F( int )
1999 ldap_txn_create_s LDAP_P((
2000         LDAP *ld,
2001         struct berval **cookie,
2002         LDAPControl **sctrls,
2003         LDAPControl **cctrls ));
2004
2005 LDAP_F( int )
2006 ldap_txn_end LDAP_P((
2007         LDAP *ld,
2008         struct berval *cookie,
2009         int commit,
2010         LDAPControl             **sctrls,
2011         LDAPControl             **cctrls,
2012         int                             *msgidp ));
2013
2014 LDAP_F( int )
2015 ldap_txn_end_s LDAP_P((
2016         LDAP *ld,
2017         struct berval *cookie,
2018         int commit,
2019         LDAPControl **sctrls,
2020         LDAPControl **cctrls ));
2021 #endif
2022
2023 /*
2024  * LDAP Who Am I?
2025  *      in whoami.c
2026  */
2027 #define LDAP_API_FEATURE_WHOAMI 1000
2028
2029 LDAP_F( int )
2030 ldap_parse_whoami LDAP_P((
2031         LDAP *ld,
2032         LDAPMessage *res,
2033         struct berval **authzid ));
2034
2035 LDAP_F( int )
2036 ldap_whoami LDAP_P(( LDAP *ld,
2037         LDAPControl             **sctrls,
2038         LDAPControl             **cctrls,
2039         int                             *msgidp ));
2040
2041 LDAP_F( int )
2042 ldap_whoami_s LDAP_P((
2043         LDAP *ld,
2044         struct berval **authzid,
2045         LDAPControl **sctrls,
2046         LDAPControl **cctrls ));
2047
2048 /*
2049  * LDAP Password Modify
2050  *      in passwd.c
2051  */
2052 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2053
2054 LDAP_F( int )
2055 ldap_parse_passwd LDAP_P((
2056         LDAP *ld,
2057         LDAPMessage *res,
2058         struct berval *newpasswd ));
2059
2060 LDAP_F( int )
2061 ldap_passwd LDAP_P(( LDAP *ld,
2062         struct berval   *user,
2063         struct berval   *oldpw,
2064         struct berval   *newpw,
2065         LDAPControl             **sctrls,
2066         LDAPControl             **cctrls,
2067         int                             *msgidp ));
2068
2069 LDAP_F( int )
2070 ldap_passwd_s LDAP_P((
2071         LDAP *ld,
2072         struct berval   *user,
2073         struct berval   *oldpw,
2074         struct berval   *newpw,
2075         struct berval *newpasswd,
2076         LDAPControl **sctrls,
2077         LDAPControl **cctrls ));
2078
2079 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2080 /*
2081  * LDAP Password Policy controls
2082  *      in ppolicy.c
2083  */
2084 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2085
2086 typedef enum passpolicyerror_enum {
2087        PP_passwordExpired = 0,
2088        PP_accountLocked = 1,
2089        PP_changeAfterReset = 2,
2090        PP_passwordModNotAllowed = 3,
2091        PP_mustSupplyOldPassword = 4,
2092        PP_insufficientPasswordQuality = 5,
2093        PP_passwordTooShort = 6,
2094        PP_passwordTooYoung = 7,
2095        PP_passwordInHistory = 8,
2096        PP_noError = 65535
2097 } LDAPPasswordPolicyError;
2098
2099 LDAP_F( int )
2100 ldap_create_passwordpolicy_control LDAP_P((
2101         LDAP *ld,
2102         LDAPControl **ctrlp ));
2103
2104 LDAP_F( int )
2105 ldap_parse_passwordpolicy_control LDAP_P((
2106         LDAP *ld,
2107         LDAPControl *ctrl,
2108         int *expirep,
2109         int *gracep,
2110         LDAPPasswordPolicyError *errorp ));
2111
2112 LDAP_F( const char * )
2113 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2114 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2115
2116 LDAP_END_DECL
2117 #endif /* _LDAP_H */