git.sur5r.net Git - openldap/blob - include/ldap.h

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