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