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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms are permitted only
   7  * as authorized by the OpenLDAP Public License.  A copy of this
   8  * license is available at http://www.OpenLDAP.org/license.html or
   9  * in file LICENSE in the top-level directory of the distribution.
  10  */
  11 /* Portions
  12  * Copyright (c) 1990 Regents of the University of Michigan.
  13  * All rights reserved.
  14  *
  15  * Redistribution and use in source and binary forms are permitted
  16  * provided that this notice is preserved and that due credit is given
  17  * to the University of Michigan at Ann Arbor. The name of the University
  18  * may not be used to endorse or promote products derived from this
  19  * software without specific prior written permission. This software
  20  * is provided ``as is'' without express or implied warranty.
  21  */
  22
  23 #ifndef _LDAP_H
  24 #define _LDAP_H
  25
  26 /* pull in lber */
  27 #include <lber.h>
  28
  29 LDAP_BEGIN_DECL
  30
  31 #define LDAP_VERSION1   1
  32 #define LDAP_VERSION2   2
  33 #define LDAP_VERSION3   3
  34
  35 #define LDAP_VERSION_MIN        LDAP_VERSION2
  36 #define LDAP_VERSION            LDAP_VERSION2
  37 #define LDAP_VERSION_MAX        LDAP_VERSION3
  38
  39 /*
  40  * We'll use 2000+draft revision for our API version number
  41  * As such, the number will be above the old RFC but below
  42  * whatever number does finally get assigned
  43  */
  44 #define LDAP_API_VERSION        2004
  45 #define LDAP_VENDOR_NAME        "OpenLDAP"
  46 /* We'll eventually release as 20000 */
  47 #define LDAP_VENDOR_VERSION     19910
  48
  49 /* OpenLDAP API Features */
  50 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  51
  52 /* include LDAP_API_FEATURE defines */
  53 #include <ldap_features.h>
  54
  55 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  56         ( defined( LDAP_THREAD_SAFE ) && \
  57                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  58         /* -lldap may or may not be thread safe */
  59         /* -lldap_r, if available, is always thread safe */
  60 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  61 #endif
  62 #if defined( LDAP_THREAD_SAFE ) && \
  63         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  64 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  65 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  66 #endif
  67
  68 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  69 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  70
  71 #define LDAP_ROOT_DSE                           ""
  72 #define LDAP_NO_ATTRS                           "1.1"
  73 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  74 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
  75
  76 /*
  77  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
  78  * 0x0000 - 0x0fff reserved for api options
  79  * 0x1000 - 0x3fff reserved for api extended options
  80  * 0x4000 - 0x7fff reserved for private and experimental options
  81  */
  82 #define LDAP_OPT_API_INFO                       0x0000
  83 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
  84 #define LDAP_OPT_DEREF                          0x0002
  85 #define LDAP_OPT_SIZELIMIT                      0x0003
  86 #define LDAP_OPT_TIMELIMIT                      0x0004
  87 /* 0x05 - 0x07 not defined by current draft */
  88 #define LDAP_OPT_REFERRALS                      0x0008
  89 #define LDAP_OPT_RESTART                        0x0009
  90 /* 0x0a - 0x10 not defined by current draft */
  91 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  92 #define LDAP_OPT_SERVER_CONTROLS        0x0012
  93 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
  94 /* 0x14 not defined by current draft */
  95 #define LDAP_OPT_API_FEATURE_INFO       0x0015
  96
  97 /* 0x16 - 0x2f not defined by current draft */
  98 #define LDAP_OPT_HOST_NAME                      0x0030
  99 #define LDAP_OPT_ERROR_NUMBER           0x0031
 100 #define LDAP_OPT_ERROR_STRING           0x0032
 101 #define LDAP_OPT_MATCHED_DN                     0x0033
 102
 103 /* 0x34 - 0x0fff not defined by current draft */
 104
 105 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
 106
 107 /* private and experimental options */
 108 /* OpenLDAP specific options */
 109 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 110 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 111 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 112 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 113 #define LDAP_OPT_URI                            0x5006
 114
 115 /* OpenLDAP TLS options */
 116 #define LDAP_OPT_X_TLS_CACERTFILE       0x6001
 117 #define LDAP_OPT_X_TLS_CACERTDIR        0x6002
 118 #define LDAP_OPT_X_TLS_CERT             0x6003
 119 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 120 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 121 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 122 #define LDAP_OPT_X_TLS                  0x6007
 123 #define LDAP_OPT_X_TLS_PROTOCOL         0x6008
 124 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6009
 125 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x600a
 126
 127 #define LDAP_OPT_X_TLS_NEVER            0
 128 #define LDAP_OPT_X_TLS_HARD             1
 129 #define LDAP_OPT_X_TLS_DEMAND           2
 130 #define LDAP_OPT_X_TLS_ALLOW            3
 131 #define LDAP_OPT_X_TLS_TRY              4
 132
 133 /* OpenLDAP SASL options */
 134 #define LDAP_OPT_X_SASL_MECH                    0x6100
 135 #define LDAP_OPT_X_SASL_REALM                   0x6101
 136 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 137 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 138 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 139 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 140 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 141 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 142 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 143 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 144
 145
 146 /* on/off values */
 147 #define LDAP_OPT_ON             ((void *) 1)
 148 #define LDAP_OPT_OFF    ((void *) 0)
 149
 150 /*
 151  * ldap_get_option() and ldap_set_option() return values.
 152  * As later versions may return other values indicating
 153  * failure, current applications should only compare returned
 154  * value against LDAP_OPT_SUCCESS.
 155  */
 156 #define LDAP_OPT_SUCCESS        0
 157 #define LDAP_OPT_ERROR          (-1)
 158
 159 #define LDAP_API_INFO_VERSION   (1)
 160 typedef struct ldapapiinfo {
 161         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 162         int             ldapai_api_version;                     /* revision of API supported */
 163         int             ldapai_protocol_version;        /* highest LDAP version supported */
 164         char    **ldapai_extensions;            /* names of API extensions */
 165         char    *ldapai_vendor_name;            /* name of supplier */
 166         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 167 } LDAPAPIInfo;
 168
 169 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
 170 typedef struct ldap_apifeature_info {
 171         int             ldapaif_info_version; /* version of this struct (1) */
 172         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
 173         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
 174 } LDAPAPIFeatureInfo;
 175
 176 typedef struct ldapcontrol {
 177         char *                  ldctl_oid;
 178         struct berval   ldctl_value;
 179         char                    ldctl_iscritical;
 180 } LDAPControl;
 181
 182 /* LDAP Controls */
 183         /* chase referrals controls */
 184 #define LDAP_CONTROL_REFERRALS  "1.2.840.113666.1.4.616"
 185 #define LDAP_CHASE_SUBORDINATE_REFERRALS        0x0020U
 186 #define LDAP_CHASE_EXTERNAL_REFERRALS   0x0040U
 187
 188 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
 189
 190 /* Experimental Controls */
 191
 192 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 193 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 194 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 195 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 196
 197 /* LDAP Unsolicited Notifications */
 198 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 199 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 200
 201 /* LDAP Extended Operations */
 202 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
 203
 204 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
 205 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID        ((ber_tag_t) 0x80U)
 206 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD       ((ber_tag_t) 0x81U)
 207 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW       ((ber_tag_t) 0x82U)
 208 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN       ((ber_tag_t) 0x80U)
 209
 210 /*
 211  * specific LDAP instantiations of BER types we know about
 212  */
 213
 214 /* Overview of LBER tag construction
 215  *
 216  *      Bits
 217  *      ______
 218  *      8 7 | CLASS
 219  *      0 0 = UNIVERSAL
 220  *      0 1 = APPLICATION
 221  *      1 0 = CONTEXT-SPECIFIC
 222  *      1 1 = PRIVATE
 223  *              _____
 224  *              | 6 | DATA-TYPE
 225  *                0 = PRIMITIVE
 226  *                1 = CONSTRUCTED
 227  *                      ___________
 228  *                      | 5 ... 1 | TAG-NUMBER
 229  */
 230
 231 /* general stuff */
 232 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 233 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 234 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octect string */
 235 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octect string */
 236 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 237 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 238
 239 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 240
 241 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 242 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 243 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 244 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 245
 246 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 247
 248
 249 /* possible operations a client can invoke */
 250 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
 251 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
 252 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
 253 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
 254 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
 255 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
 256 #define LDAP_REQ_MODRDN                 ((ber_tag_t) 0x6cU)     /* application + constructed */
 257 #define LDAP_REQ_MODDN                  LDAP_REQ_MODRDN
 258 #define LDAP_REQ_RENAME                 LDAP_REQ_MODRDN
 259 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
 260 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
 261 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
 262
 263 /* possible result types a server can return */
 264 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
 265 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
 266 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 267 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
 268 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
 269 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
 270 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
 271 #define LDAP_RES_MODRDN                 ((ber_tag_t) 0x6dU)     /* application + constructed */
 272 #define LDAP_RES_MODDN                  LDAP_RES_MODRDN /* application + constructed */
 273 #define LDAP_RES_RENAME                 LDAP_RES_MODRDN /* application + constructed */
 274 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
 275 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 276 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
 277
 278 #define LDAP_RES_ANY                    (-1)
 279 #define LDAP_RES_UNSOLICITED    (0)
 280
 281
 282 /* sasl methods */
 283 #define LDAP_SASL_SIMPLE                        NULL
 284
 285 /* authentication methods available */
 286 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
 287 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
 288 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + primitive   */
 289 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
 290 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
 291 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
 292
 293
 294 /* filter types */
 295 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 296 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 297 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 298 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 299 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 300 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 301 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 302 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 303 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 304 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 305
 306 /* extended filter component types */
 307 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
 308 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 309 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 310 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 311
 312 /* substring filter component types */
 313 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 314 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 315 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 316
 317 /* search scopes */
 318 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 319 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 320 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 321
 322 /* substring filter component types */
 323 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 324 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 325 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 326
 327 /*
 328  * possible error codes we can return
 329  */
 330
 331 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 332
 333 #define LDAP_SUCCESS                    0x00
 334 #define LDAP_OPERATIONS_ERROR           0x01
 335 #define LDAP_PROTOCOL_ERROR             0x02
 336 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 337 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 338 #define LDAP_COMPARE_FALSE              0x05
 339 #define LDAP_COMPARE_TRUE               0x06
 340 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 341 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 342 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 343 #define LDAP_PARTIAL_RESULTS            0x09    /* not listed in v3 */
 344
 345 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 346 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 347 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 348 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 349 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 350
 351 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 352
 353 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 354 #define LDAP_UNDEFINED_TYPE             0x11
 355 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 356 #define LDAP_CONSTRAINT_VIOLATION       0x13
 357 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 358 #define LDAP_INVALID_SYNTAX             0x15
 359
 360 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 361
 362 #define LDAP_NO_SUCH_OBJECT             0x20
 363 #define LDAP_ALIAS_PROBLEM              0x21
 364 #define LDAP_INVALID_DN_SYNTAX          0x22
 365 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 366 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 367
 368 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
 369
 370 #define LDAP_INAPPROPRIATE_AUTH         0x30
 371 #define LDAP_INVALID_CREDENTIALS        0x31
 372 #define LDAP_INSUFFICIENT_ACCESS        0x32
 373
 374 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 375
 376 #define LDAP_BUSY                       0x33
 377 #define LDAP_UNAVAILABLE                0x34
 378 #define LDAP_UNWILLING_TO_PERFORM       0x35
 379 #define LDAP_LOOP_DETECT                0x36
 380
 381 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 382
 383 #define LDAP_NAMING_VIOLATION           0x40
 384 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 385 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 386 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 387 #define LDAP_ALREADY_EXISTS             0x44
 388 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 389 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 390 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 391
 392 #define LDAP_OTHER                      0x50
 393
 394 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 395
 396 #define LDAP_SERVER_DOWN                0x51
 397 #define LDAP_LOCAL_ERROR                0x52
 398 #define LDAP_ENCODING_ERROR             0x53
 399 #define LDAP_DECODING_ERROR             0x54
 400 #define LDAP_TIMEOUT                    0x55
 401 #define LDAP_AUTH_UNKNOWN               0x56
 402 #define LDAP_FILTER_ERROR               0x57
 403 #define LDAP_USER_CANCELLED             0x58
 404 #define LDAP_PARAM_ERROR                0x59
 405 #define LDAP_NO_MEMORY                  0x5a
 406
 407 /* not technically reserved for APIs */
 408 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 409 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 410 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 411 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 412 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 413 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 414 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 415
 416 /*
 417  * This structure represents both ldap messages and ldap responses.
 418  * These are really the same, except in the case of search responses,
 419  * where a response has multiple messages.
 420  */
 421
 422 typedef struct ldapmsg LDAPMessage;
 423
 424 /* for modifications */
 425 typedef struct ldapmod {
 426         int             mod_op;
 427
 428 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 429 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 430 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 431 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 432 /* IMPORTANT: do not use code 0x1000 (or above),
 433  * it is used internally by the backends!
 434  * (see ldap/servers/slapd/slap.h)
 435  */
 436
 437         char            *mod_type;
 438         union mod_vals_u {
 439                 char            **modv_strvals;
 440                 struct berval   **modv_bvals;
 441         } mod_vals;
 442 #define mod_values      mod_vals.modv_strvals
 443 #define mod_bvalues     mod_vals.modv_bvals
 444 } LDAPMod;
 445
 446 /*
 447  * structures for ldap getfilter routines
 448  */
 449
 450 typedef struct ldap_filt_info {
 451         char                    *lfi_filter;
 452         char                    *lfi_desc;
 453         int                     lfi_scope;
 454         int                     lfi_isexact;
 455         struct ldap_filt_info   *lfi_next;
 456 } LDAPFiltInfo;
 457
 458 typedef struct ldap_filt_list {
 459     char                        *lfl_tag;
 460     char                        *lfl_pattern;
 461     char                        *lfl_delims;
 462     LDAPFiltInfo                *lfl_ilist;
 463     struct ldap_filt_list       *lfl_next;
 464 } LDAPFiltList;
 465
 466
 467 #define LDAP_FILT_MAXSIZ        1024
 468
 469 typedef struct ldap_filt_desc {
 470         LDAPFiltList            *lfd_filtlist;
 471         LDAPFiltInfo            *lfd_curfip;
 472         LDAPFiltInfo            lfd_retfi;
 473         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 474         char                    *lfd_curval;
 475         char                    *lfd_curvalcopy;
 476         char                    **lfd_curvalwords;
 477         char                    *lfd_filtprefix;
 478         char                    *lfd_filtsuffix;
 479 } LDAPFiltDesc;
 480
 481
 482 /*
 483  * structure representing an ldap session which can
 484  * encompass connections to multiple servers (in the
 485  * face of referrals).
 486  */
 487 typedef struct ldap LDAP;
 488
 489 #define LDAP_DEREF_NEVER        0x00
 490 #define LDAP_DEREF_SEARCHING    0x01
 491 #define LDAP_DEREF_FINDING      0x02
 492 #define LDAP_DEREF_ALWAYS       0x03
 493
 494 #define LDAP_NO_LIMIT           0
 495
 496 /* how many messages to retrieve results for */
 497 #define LDAP_MSG_ONE            0x00
 498 #define LDAP_MSG_ALL            0x01
 499 #define LDAP_MSG_RECEIVED       0x02
 500
 501 /*
 502  * structure for ldap friendly mapping routines
 503  */
 504
 505 typedef struct ldap_friendly {
 506         char    *lf_unfriendly;
 507         char    *lf_friendly;
 508 } LDAPFriendlyMap;
 509
 510 /*
 511  * types for ldap URL handling
 512  */
 513 typedef struct ldap_url_desc {
 514     struct ldap_url_desc *lud_next;
 515     char        *lud_scheme;
 516     char        *lud_host;
 517     int         lud_port;
 518     char        *lud_dn;
 519     char        **lud_attrs;
 520     int         lud_scope;
 521     char        *lud_filter;
 522     char        **lud_exts;
 523 } LDAPURLDesc;
 524
 525 #define LDAP_URL_SUCCESS                0x00    /* Success */
 526 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 527 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 528
 529 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 530 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 531 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 532 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 533 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 534 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 535 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 536 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 537
 538 /*
 539  * The API draft spec says we should declare (or cause to be declared)
 540  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 541  */
 542 struct timeval;
 543
 544 /*
 545  * in options.c:
 546  */
 547 LDAP_F( int )
 548 ldap_get_option LDAP_P((
 549         LDAP *ld,
 550         int option,
 551         void *outvalue));
 552
 553 LDAP_F( int )
 554 ldap_set_option LDAP_P((
 555         LDAP *ld,
 556         int option,
 557         LDAP_CONST void *invalue));
 558
 559 /* V3 REBIND Function Callback Prototype */
 560 typedef int (LDAP_REBIND_PROC) LDAP_P((
 561         LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
 562
 563 LDAP_F( int )
 564 ldap_set_rebind_proc LDAP_P((
 565         LDAP *ld,
 566         LDAP_REBIND_PROC *ldap_proc));
 567
 568 /*
 569  * in controls.c:
 570  */
 571 LDAP_F( void )
 572 ldap_control_free LDAP_P((
 573         LDAPControl *ctrl ));
 574
 575 LDAP_F( void )
 576 ldap_controls_free LDAP_P((
 577         LDAPControl **ctrls ));
 578
 579 /*
 580  * in dnssrv.c:
 581  */
 582 LDAP_F( int )
 583 ldap_domain2dn LDAP_P((
 584         LDAP_CONST char* domain,
 585         char** dn ));
 586
 587 LDAP_F( int )
 588 ldap_dn2domain LDAP_P((
 589         LDAP_CONST char* dn,
 590         char** domain ));
 591
 592 LDAP_F( int )
 593 ldap_domain2hostlist LDAP_P((
 594         LDAP_CONST char *domain,
 595         char** hostlist ));
 596
 597 /*
 598  * in extended.c:
 599  */
 600 LDAP_F( int )
 601 ldap_extended_operation LDAP_P((
 602         LDAP                    *ld,
 603         LDAP_CONST char *reqoid,
 604         struct berval   *reqdata,
 605         LDAPControl             **serverctrls,
 606         LDAPControl             **clientctrls,
 607         int                             *msgidp ));
 608
 609 LDAP_F( int )
 610 ldap_extended_operation_s LDAP_P((
 611         LDAP                    *ld,
 612         LDAP_CONST char *reqoid,
 613         struct berval   *reqdata,
 614         LDAPControl             **serverctrls,
 615         LDAPControl             **clientctrls,
 616         char                    **retoidp,
 617         struct berval   **retdatap ));
 618
 619 LDAP_F( int )
 620 ldap_parse_extended_result LDAP_P((
 621         LDAP                    *ld,
 622         LDAPMessage             *res,
 623         char                    **retoidp,
 624         struct berval   **retdatap,
 625         int                             freeit ));
 626
 627 LDAP_F( int )
 628 ldap_parse_extended_partial LDAP_P((
 629         LDAP                    *ld,
 630         LDAPMessage             *res,
 631         char                    **retoidp,
 632         struct berval   **retdatap,
 633         LDAPControl             ***serverctrls,
 634         int                             freeit ));
 635
 636 /*
 637  * in abandon.c:
 638  */
 639 LDAP_F( int )
 640 ldap_abandon_ext LDAP_P((
 641         LDAP                    *ld,
 642         int                             msgid,
 643         LDAPControl             **serverctrls,
 644         LDAPControl             **clientctrls ));
 645
 646 LDAP_F( int )
 647 ldap_abandon LDAP_P((   /* deprecated */
 648         LDAP *ld,
 649         int msgid ));
 650
 651
 652 /*
 653  * in add.c:
 654  */
 655 LDAP_F( int )
 656 ldap_add_ext LDAP_P((
 657         LDAP                    *ld,
 658         LDAP_CONST char *dn,
 659         LDAPMod                 **attrs,
 660         LDAPControl             **serverctrls,
 661         LDAPControl             **clientctrls,
 662         int                     *msgidp ));
 663
 664 LDAP_F( int )
 665 ldap_add_ext_s LDAP_P((
 666         LDAP                    *ld,
 667         LDAP_CONST char *dn,
 668         LDAPMod                 **attrs,
 669         LDAPControl             **serverctrls,
 670         LDAPControl             **clientctrls ));
 671
 672 LDAP_F( int )
 673 ldap_add LDAP_P((       /* deprecated */
 674         LDAP *ld,
 675         LDAP_CONST char *dn,
 676         LDAPMod **attrs ));
 677
 678 LDAP_F( int )
 679 ldap_add_s LDAP_P((     /* deprecated */
 680         LDAP *ld,
 681         LDAP_CONST char *dn,
 682         LDAPMod **attrs ));
 683
 684
 685 /*
 686  * in sasl.c:
 687  */
 688 LDAP_F( int )
 689 ldap_sasl_bind LDAP_P((
 690         LDAP                    *ld,
 691         LDAP_CONST char *dn,
 692         LDAP_CONST char *mechanism,
 693         struct berval   *cred,
 694         LDAPControl             **serverctrls,
 695         LDAPControl             **clientctrls,
 696         int                             *msgidp ));
 697
 698 /* Interaction flags (should be passed about in a control)
 699  *  Automatic (default): use defaults, prompt otherwise
 700  *  Interactive: prompt always
 701  *  Quiet: never prompt
 702  */
 703 #define LDAP_SASL_AUTOMATIC             0U
 704 #define LDAP_SASL_INTERACTIVE   1U
 705 #define LDAP_SASL_QUIET                 2U
 706
 707 /*
 708  * V3 SASL Interaction Function Callback Prototype
 709  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 710  *  should likely passed in a control (and provided controls)
 711  */
 712 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 713         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 714
 715 LDAP_F( int )
 716 ldap_sasl_interactive_bind_s LDAP_P((
 717         LDAP *ld,
 718         LDAP_CONST char *dn, /* usually NULL */
 719         LDAP_CONST char *saslMechanism,
 720         LDAPControl **serverControls,
 721         LDAPControl **clientControls,
 722
 723         /* should be client controls */
 724         unsigned flags,
 725         LDAP_SASL_INTERACT_PROC *proc,
 726         void *defaults ));
 727
 728 LDAP_F( int )
 729 ldap_sasl_bind_s LDAP_P((
 730         LDAP                    *ld,
 731         LDAP_CONST char *dn,
 732         LDAP_CONST char *mechanism,
 733         struct berval   *cred,
 734         LDAPControl             **serverctrls,
 735         LDAPControl             **clientctrls,
 736         struct berval   **servercredp ));
 737
 738 LDAP_F( int )
 739 ldap_parse_sasl_bind_result LDAP_P((
 740         LDAP                    *ld,
 741         LDAPMessage             *res,
 742         struct berval   **servercredp,
 743         int                             freeit ));
 744
 745 /*
 746  * in bind.c:
 747  *      (deprecated)
 748  */
 749 LDAP_F( int )
 750 ldap_bind LDAP_P((      /* deprecated */
 751         LDAP *ld,
 752         LDAP_CONST char *who,
 753         LDAP_CONST char *passwd,
 754         int authmethod ));
 755
 756 LDAP_F( int )
 757 ldap_bind_s LDAP_P((    /* deprecated */
 758         LDAP *ld,
 759         LDAP_CONST char *who,
 760         LDAP_CONST char *cred,
 761         int authmethod ));
 762
 763 /*
 764  * in sbind.c:
 765  */
 766 LDAP_F( int )
 767 ldap_simple_bind LDAP_P((
 768         LDAP *ld,
 769         LDAP_CONST char *who,
 770         LDAP_CONST char *passwd ));
 771
 772 LDAP_F( int )
 773 ldap_simple_bind_s LDAP_P((
 774         LDAP *ld,
 775         LDAP_CONST char *who,
 776         LDAP_CONST char *passwd ));
 777
 778
 779 /*
 780  * in kbind.c:
 781  *      (deprecated)
 782  */
 783 LDAP_F( int )
 784 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 785         LDAP *ld,
 786         LDAP_CONST char *who ));
 787
 788 LDAP_F( int )
 789 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 790         LDAP *ld,
 791         LDAP_CONST char *who ));
 792
 793 LDAP_F( int )
 794 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 795         LDAP *ld,
 796         LDAP_CONST char *who ));
 797
 798 LDAP_F( int )
 799 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 800         LDAP *ld,
 801         LDAP_CONST char *who ));
 802
 803 LDAP_F( int )
 804 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 805         LDAP *ld,
 806         LDAP_CONST char *who ));
 807
 808 /*
 809  * in cache.c
 810  * (deprecated)
 811  */
 812 LDAP_F( int )
 813 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 814
 815 LDAP_F( void )
 816 ldap_disable_cache LDAP_P(( LDAP *ld ));
 817
 818 LDAP_F( void )
 819 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 820
 821 LDAP_F( void )
 822 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 823
 824 LDAP_F( void )
 825 ldap_flush_cache LDAP_P(( LDAP *ld ));
 826
 827 LDAP_F( void )
 828 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 829
 830 LDAP_F( void )
 831 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 832
 833
 834 /*
 835  * in compare.c:
 836  */
 837 LDAP_F( int )
 838 ldap_compare_ext LDAP_P((
 839         LDAP                    *ld,
 840         LDAP_CONST char *dn,
 841         LDAP_CONST char *attr,
 842         struct berval   *bvalue,
 843         LDAPControl             **serverctrls,
 844         LDAPControl             **clientctrls,
 845         int                     *msgidp ));
 846
 847 LDAP_F( int )
 848 ldap_compare_ext_s LDAP_P((
 849         LDAP                    *ld,
 850         LDAP_CONST char *dn,
 851         LDAP_CONST char *attr,
 852         struct berval   *bvalue,
 853         LDAPControl             **serverctrls,
 854         LDAPControl             **clientctrls ));
 855
 856 LDAP_F( int )
 857 ldap_compare LDAP_P((   /* deprecated */
 858         LDAP *ld,
 859         LDAP_CONST char *dn,
 860         LDAP_CONST char *attr,
 861         LDAP_CONST char *value ));
 862
 863 LDAP_F( int )
 864 ldap_compare_s LDAP_P(( /* deprecated */
 865         LDAP *ld,
 866         LDAP_CONST char *dn,
 867         LDAP_CONST char *attr,
 868         LDAP_CONST char *value ));
 869
 870
 871 /*
 872  * in delete.c:
 873  */
 874 LDAP_F( int )
 875 ldap_delete_ext LDAP_P((
 876         LDAP                    *ld,
 877         LDAP_CONST char *dn,
 878         LDAPControl             **serverctrls,
 879         LDAPControl             **clientctrls,
 880         int                     *msgidp ));
 881
 882 LDAP_F( int )
 883 ldap_delete_ext_s LDAP_P((
 884         LDAP                    *ld,
 885         LDAP_CONST char *dn,
 886         LDAPControl             **serverctrls,
 887         LDAPControl             **clientctrls ));
 888
 889 LDAP_F( int )
 890 ldap_delete LDAP_P((    /* deprecated */
 891         LDAP *ld,
 892         LDAP_CONST char *dn ));
 893
 894 LDAP_F( int )
 895 ldap_delete_s LDAP_P((  /* deprecated */
 896         LDAP *ld,
 897         LDAP_CONST char *dn ));
 898
 899
 900 /*
 901  * in error.c:
 902  */
 903 LDAP_F( int )
 904 ldap_parse_result LDAP_P((
 905         LDAP                    *ld,
 906         LDAPMessage             *res,
 907         int                             *errcodep,
 908         char                    **matcheddnp,
 909         char                    **errmsgp,
 910         char                    ***referralsp,
 911         LDAPControl             ***serverctrls,
 912         int                             freeit ));
 913
 914 LDAP_F( char *)
 915 ldap_err2string LDAP_P((
 916         int err ));
 917
 918 LDAP_F( int )
 919 ldap_result2error LDAP_P((      /* deprecated */
 920         LDAP *ld,
 921         LDAPMessage *r,
 922         int freeit ));
 923
 924 LDAP_F( void )
 925 ldap_perror LDAP_P((    /* deprecated */
 926         LDAP *ld,
 927         LDAP_CONST char *s ));
 928
 929
 930 /*
 931  * in modify.c:
 932  */
 933 LDAP_F( int )
 934 ldap_modify_ext LDAP_P((
 935         LDAP                    *ld,
 936         LDAP_CONST char *dn,
 937         LDAPMod                 **mods,
 938         LDAPControl             **serverctrls,
 939         LDAPControl             **clientctrls,
 940         int                     *msgidp ));
 941
 942 LDAP_F( int )
 943 ldap_modify_ext_s LDAP_P((
 944         LDAP                    *ld,
 945         LDAP_CONST char *dn,
 946         LDAPMod                 **mods,
 947         LDAPControl             **serverctrls,
 948         LDAPControl             **clientctrls ));
 949
 950 LDAP_F( int )
 951 ldap_modify LDAP_P((    /* deprecated */
 952         LDAP *ld,
 953         LDAP_CONST char *dn,
 954         LDAPMod **mods ));
 955
 956 LDAP_F( int )
 957 ldap_modify_s LDAP_P((  /* deprecated */
 958         LDAP *ld,
 959         LDAP_CONST char *dn,
 960         LDAPMod **mods ));
 961
 962
 963 /*
 964  * in modrdn.c:
 965  */
 966 LDAP_F( int )
 967 ldap_rename LDAP_P((
 968         LDAP *ld,
 969         LDAP_CONST char *dn,
 970         LDAP_CONST char *newrdn,
 971         LDAP_CONST char *newSuperior,
 972         int deleteoldrdn,
 973         LDAPControl **sctrls,
 974         LDAPControl **cctrls,
 975         int *msgidp ));
 976
 977 LDAP_F( int )
 978 ldap_rename_s LDAP_P((
 979         LDAP *ld,
 980         LDAP_CONST char *dn,
 981         LDAP_CONST char *newrdn,
 982         LDAP_CONST char *newSuperior,
 983         int deleteoldrdn,
 984         LDAPControl **sctrls,
 985         LDAPControl **cctrls ));
 986
 987 LDAP_F( int )
 988 ldap_rename2 LDAP_P((   /* deprecated */
 989         LDAP *ld,
 990         LDAP_CONST char *dn,
 991         LDAP_CONST char *newrdn,
 992         LDAP_CONST char *newSuperior,
 993         int deleteoldrdn ));
 994
 995 LDAP_F( int )
 996 ldap_rename2_s LDAP_P(( /* deprecated */
 997         LDAP *ld,
 998         LDAP_CONST char *dn,
 999         LDAP_CONST char *newrdn,
1000         LDAP_CONST char *newSuperior,
1001         int deleteoldrdn ));
1002
1003 LDAP_F( int )
1004 ldap_modrdn LDAP_P((    /* deprecated */
1005         LDAP *ld,
1006         LDAP_CONST char *dn,
1007         LDAP_CONST char *newrdn ));
1008
1009 LDAP_F( int )
1010 ldap_modrdn_s LDAP_P((  /* deprecated */
1011         LDAP *ld,
1012         LDAP_CONST char *dn,
1013         LDAP_CONST char *newrdn ));
1014
1015 LDAP_F( int )
1016 ldap_modrdn2 LDAP_P((   /* deprecated */
1017         LDAP *ld,
1018         LDAP_CONST char *dn,
1019         LDAP_CONST char *newrdn,
1020         int deleteoldrdn ));
1021
1022 LDAP_F( int )
1023 ldap_modrdn2_s LDAP_P(( /* deprecated */
1024         LDAP *ld,
1025         LDAP_CONST char *dn,
1026         LDAP_CONST char *newrdn,
1027         int deleteoldrdn));
1028
1029
1030 /*
1031  * in open.c:
1032  */
1033 LDAP_F( LDAP *)
1034 ldap_init LDAP_P((
1035         LDAP_CONST char *host,
1036         int port ));
1037
1038 LDAP_F( LDAP *)
1039 ldap_open LDAP_P((      /* deprecated */
1040         LDAP_CONST char *host,
1041         int port ));
1042
1043 LDAP_F( int )
1044 ldap_create LDAP_P((
1045         LDAP **ldp ));
1046
1047 LDAP_F( int )
1048 ldap_initialize LDAP_P((
1049         LDAP **ldp,
1050         LDAP_CONST char *url ));
1051
1052 LDAP_F( int )
1053 ldap_start_tls_s LDAP_P((
1054         LDAP *ld,
1055         LDAPControl **serverctrls,
1056         LDAPControl **clientctrls ));
1057
1058 /*
1059  * in messages.c:
1060  */
1061 LDAP_F( LDAPMessage *)
1062 ldap_first_message LDAP_P((
1063         LDAP *ld,
1064         LDAPMessage *chain ));
1065
1066 LDAP_F( LDAPMessage *)
1067 ldap_next_message LDAP_P((
1068         LDAP *ld,
1069         LDAPMessage *msg ));
1070
1071 LDAP_F( int )
1072 ldap_count_messages LDAP_P((
1073         LDAP *ld,
1074         LDAPMessage *chain ));
1075
1076
1077 /*
1078  * in references.c:
1079  */
1080 LDAP_F( LDAPMessage *)
1081 ldap_first_reference LDAP_P((
1082         LDAP *ld,
1083         LDAPMessage *chain ));
1084
1085 LDAP_F( LDAPMessage *)
1086 ldap_next_reference LDAP_P((
1087         LDAP *ld,
1088         LDAPMessage *ref ));
1089
1090 LDAP_F( int )
1091 ldap_count_references LDAP_P((
1092         LDAP *ld,
1093         LDAPMessage *chain ));
1094
1095 LDAP_F( int )
1096 ldap_parse_reference LDAP_P((
1097         LDAP                    *ld,
1098         LDAPMessage             *ref,
1099         char                    ***referralsp,
1100         LDAPControl             ***serverctrls,
1101         int                             freeit));
1102
1103
1104 /*
1105  * in getentry.c:
1106  */
1107 LDAP_F( LDAPMessage *)
1108 ldap_first_entry LDAP_P((
1109         LDAP *ld,
1110         LDAPMessage *chain ));
1111
1112 LDAP_F( LDAPMessage *)
1113 ldap_next_entry LDAP_P((
1114         LDAP *ld,
1115         LDAPMessage *entry ));
1116
1117 LDAP_F( int )
1118 ldap_count_entries LDAP_P((
1119         LDAP *ld,
1120         LDAPMessage *chain ));
1121
1122 LDAP_F( int )
1123 ldap_get_entry_controls LDAP_P((
1124         LDAP                    *ld,
1125         LDAPMessage             *entry,
1126         LDAPControl             ***serverctrls));
1127
1128
1129 /*
1130  * in addentry.c
1131  */
1132 LDAP_F( LDAPMessage *)
1133 ldap_delete_result_entry LDAP_P((
1134         LDAPMessage **list,
1135         LDAPMessage *e ));
1136
1137 LDAP_F( void )
1138 ldap_add_result_entry LDAP_P((
1139         LDAPMessage **list,
1140         LDAPMessage *e ));
1141
1142
1143 /*
1144  * in getdn.c
1145  */
1146 LDAP_F( char * )
1147 ldap_get_dn LDAP_P((
1148         LDAP *ld,
1149         LDAPMessage *entry ));
1150
1151 LDAP_F( char * )
1152 ldap_dn2ufn LDAP_P((
1153         LDAP_CONST char *dn ));
1154
1155 LDAP_F( char ** )
1156 ldap_explode_dn LDAP_P((
1157         LDAP_CONST char *dn,
1158         int notypes ));
1159
1160 LDAP_F( char ** )
1161 ldap_explode_rdn LDAP_P((
1162         LDAP_CONST char *rdn,
1163         int notypes ));
1164
1165 LDAP_F( char * )
1166 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1167
1168 LDAP_F( char * )
1169 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1170
1171 /*
1172  * in getattr.c
1173  */
1174 LDAP_F( char *)
1175 ldap_first_attribute LDAP_P((
1176         LDAP *ld,
1177         LDAPMessage *entry,
1178         BerElement **ber ));
1179
1180 LDAP_F( char *)
1181 ldap_next_attribute LDAP_P((
1182         LDAP *ld,
1183         LDAPMessage *entry,
1184         BerElement *ber ));
1185
1186
1187 /*
1188  * in getvalues.c
1189  */
1190 LDAP_F( char **)
1191 ldap_get_values LDAP_P((
1192         LDAP *ld,
1193         LDAPMessage *entry,
1194         LDAP_CONST char *target ));
1195
1196 LDAP_F( struct berval **)
1197 ldap_get_values_len LDAP_P((
1198         LDAP *ld,
1199         LDAPMessage *entry,
1200         LDAP_CONST char *target ));
1201
1202 LDAP_F( int )
1203 ldap_count_values LDAP_P((
1204         char **vals ));
1205
1206 LDAP_F( int )
1207 ldap_count_values_len LDAP_P((
1208         struct berval **vals ));
1209
1210 LDAP_F( void )
1211 ldap_value_free LDAP_P((
1212         char **vals ));
1213
1214 LDAP_F( void )
1215 ldap_value_free_len LDAP_P((
1216         struct berval **vals ));
1217
1218 /*
1219  * in result.c:
1220  */
1221 LDAP_F( int )
1222 ldap_result LDAP_P((
1223         LDAP *ld,
1224         int msgid,
1225         int all,
1226         struct timeval *timeout,
1227         LDAPMessage **result ));
1228
1229 LDAP_F( int )
1230 ldap_msgtype LDAP_P((
1231         LDAPMessage *lm ));
1232
1233 LDAP_F( int )
1234 ldap_msgid   LDAP_P((
1235         LDAPMessage *lm ));
1236
1237 LDAP_F( int )
1238 ldap_msgfree LDAP_P((
1239         LDAPMessage *lm ));
1240
1241 LDAP_F( int )
1242 ldap_msgdelete LDAP_P((
1243         LDAP *ld,
1244         int msgid ));
1245
1246
1247 /*
1248  * in search.c:
1249  */
1250 LDAP_F( int )
1251 ldap_search_ext LDAP_P((
1252         LDAP                    *ld,
1253         LDAP_CONST char *base,
1254         int                             scope,
1255         LDAP_CONST char *filter,
1256         char                    **attrs,
1257         int                             attrsonly,
1258         LDAPControl             **serverctrls,
1259         LDAPControl             **clientctrls,
1260         struct timeval  *timeout,
1261         int                             sizelimit,
1262         int                             *msgidp ));
1263
1264 LDAP_F( int )
1265 ldap_search_ext_s LDAP_P((
1266         LDAP                    *ld,
1267         LDAP_CONST char *base,
1268         int                             scope,
1269         LDAP_CONST char *filter,
1270         char                    **attrs,
1271         int                             attrsonly,
1272         LDAPControl             **serverctrls,
1273         LDAPControl             **clientctrls,
1274         struct timeval  *timeout,
1275         int                             sizelimit,
1276         LDAPMessage             **res ));
1277
1278 LDAP_F( int )
1279 ldap_search LDAP_P((    /* deprecated */
1280         LDAP *ld,
1281         LDAP_CONST char *base,
1282         int scope,
1283         LDAP_CONST char *filter,
1284         char **attrs,
1285         int attrsonly ));
1286
1287 LDAP_F( int )
1288 ldap_search_s LDAP_P((  /* deprecated */
1289         LDAP *ld,
1290         LDAP_CONST char *base,
1291         int scope,
1292         LDAP_CONST char *filter,
1293         char **attrs,
1294         int attrsonly,
1295         LDAPMessage **res ));
1296
1297 LDAP_F( int )
1298 ldap_search_st LDAP_P(( /* deprecated */
1299         LDAP *ld,
1300         LDAP_CONST char *base,
1301         int scope,
1302         LDAP_CONST char *filter,
1303     char **attrs,
1304         int attrsonly,
1305         struct timeval *timeout,
1306         LDAPMessage **res ));
1307
1308
1309 /*
1310  * in ufn.c
1311  *      (deprecated)
1312  */
1313 LDAP_F( int )
1314 ldap_ufn_search_c LDAP_P(( /* deprecated */
1315         LDAP *ld,
1316         LDAP_CONST char *ufn,
1317         char **attrs,
1318         int attrsonly,
1319         LDAPMessage **res,
1320         int (*cancelproc)( void *cl ),
1321         void *cancelparm ));
1322
1323 LDAP_F( int )
1324 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1325         LDAP *ld,
1326         LDAP_CONST char *ufn,
1327         char **attrs,
1328         int attrsonly,
1329         LDAPMessage **res,
1330         int (*cancelproc)( void *cl ),
1331         void *cancelparm,
1332         char *tag1,
1333         char *tag2,
1334         char *tag3 ));
1335
1336 LDAP_F( int )
1337 ldap_ufn_search_s LDAP_P(( /* deprecated */
1338         LDAP *ld,
1339         LDAP_CONST char *ufn,
1340         char **attrs,
1341         int attrsonly,
1342         LDAPMessage **res ));
1343
1344 LDAP_F( LDAPFiltDesc *)
1345 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1346         LDAP *ld,
1347         LDAP_CONST char *fname ));
1348
1349 LDAP_F( void )
1350 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1351         LDAP *ld,
1352         LDAP_CONST char *prefix ));
1353
1354 LDAP_F( int )
1355 ldap_ufn_timeout LDAP_P(( /* deprecated */
1356         void *tvparam ));
1357
1358
1359 /*
1360  * in unbind.c
1361  */
1362 LDAP_F( int )
1363 ldap_unbind LDAP_P(( /* deprecated */
1364         LDAP *ld ));
1365
1366 LDAP_F( int )
1367 ldap_unbind_s LDAP_P(( /* deprecated */
1368         LDAP *ld ));
1369
1370 LDAP_F( int )
1371 ldap_unbind_ext LDAP_P((
1372         LDAP                    *ld,
1373         LDAPControl             **serverctrls,
1374         LDAPControl             **clientctrls));
1375
1376 LDAP_F( int )
1377 ldap_unbind_ext_s LDAP_P((
1378         LDAP                    *ld,
1379         LDAPControl             **serverctrls,
1380         LDAPControl             **clientctrls));
1381
1382 /*
1383  * in getfilter.c
1384  *      (deprecated)
1385  */
1386 LDAP_F( LDAPFiltDesc *)
1387 ldap_init_getfilter LDAP_P(( /* deprecated */
1388         LDAP_CONST char *fname ));
1389
1390 LDAP_F( LDAPFiltDesc *)
1391 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1392         /* LDAP_CONST */ char *buf,
1393         ber_len_t buflen ));
1394
1395 LDAP_F( LDAPFiltInfo *)
1396 ldap_getfirstfilter LDAP_P(( /* deprecated */
1397         LDAPFiltDesc *lfdp,
1398         /* LDAP_CONST */ char *tagpat,
1399         /* LDAP_CONST */ char *value ));
1400
1401 LDAP_F( LDAPFiltInfo *)
1402 ldap_getnextfilter LDAP_P(( /* deprecated */
1403         LDAPFiltDesc *lfdp ));
1404
1405 LDAP_F( void )
1406 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1407         LDAPFiltDesc *lfdp,
1408         LDAP_CONST char *prefix,
1409         LDAP_CONST char *suffix ));
1410
1411 LDAP_F( void )
1412 ldap_build_filter LDAP_P(( /* deprecated */
1413         char *buf,
1414         ber_len_t buflen,
1415         LDAP_CONST char *pattern,
1416         LDAP_CONST char *prefix,
1417         LDAP_CONST char *suffix,
1418         LDAP_CONST char *attr,
1419         LDAP_CONST char *value,
1420         char **valwords ));
1421
1422
1423 /*
1424  * in free.c
1425  */
1426
1427 LDAP_F( void * )
1428 ldap_memalloc LDAP_P((
1429         ber_len_t s ));
1430
1431 LDAP_F( void * )
1432 ldap_memrealloc LDAP_P((
1433         void* p,
1434         ber_len_t s ));
1435
1436 LDAP_F( void * )
1437 ldap_memcalloc LDAP_P((
1438         ber_len_t n,
1439         ber_len_t s ));
1440
1441 LDAP_F( void )
1442 ldap_memfree LDAP_P((
1443         void* p ));
1444
1445 LDAP_F( void )
1446 ldap_memvfree LDAP_P((
1447         void** v ));
1448
1449 LDAP_F( char * )
1450 ldap_strdup LDAP_P((
1451         LDAP_CONST char * ));
1452
1453 LDAP_F( void )
1454 ldap_getfilter_free LDAP_P((
1455         LDAPFiltDesc *lfdp ));
1456
1457 LDAP_F( void )
1458 ldap_mods_free LDAP_P((
1459         LDAPMod **mods,
1460         int freemods ));
1461
1462
1463 /*
1464  * in friendly.c
1465  *      (deprecated)
1466  */
1467 LDAP_F( char * )
1468 ldap_friendly_name LDAP_P(( /* deprecated */
1469         LDAP_CONST char *filename,
1470         /* LDAP_CONST */ char *uname,
1471         LDAPFriendlyMap **map ));
1472
1473 LDAP_F( void )
1474 ldap_free_friendlymap LDAP_P(( /* deprecated */
1475         LDAPFriendlyMap **map ));
1476
1477
1478 /*
1479  * in cldap.c
1480  *      (deprecated)
1481  */
1482 LDAP_F( LDAP * )
1483 cldap_open LDAP_P((     /* deprecated */
1484         LDAP_CONST char *host,
1485         int port ));
1486
1487 LDAP_F( void )
1488 cldap_close LDAP_P((    /* deprecated */
1489         LDAP *ld ));
1490
1491 LDAP_F( int )
1492 cldap_search_s LDAP_P(( /* deprecated */
1493         LDAP *ld,
1494         LDAP_CONST char *base,
1495         int scope,
1496         LDAP_CONST char *filter,
1497         char **attrs,
1498         int attrsonly,
1499         LDAPMessage **res,
1500         char *logdn ));
1501
1502 LDAP_F( void )
1503 cldap_setretryinfo LDAP_P(( /* deprecated */
1504         LDAP *ld,
1505         int tries,
1506         int timeout ));
1507
1508
1509 /*
1510  * in sort.c
1511  */
1512 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1513         LDAP_CONST char *left,
1514         LDAP_CONST char *right ));
1515
1516 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1517         LDAP_CONST void *left,
1518         LDAP_CONST void *right ));
1519
1520 LDAP_F( int )
1521 ldap_sort_entries LDAP_P(( LDAP *ld,
1522         LDAPMessage **chain,
1523         LDAP_CONST char *attr,
1524         LDAP_SORT_AD_CMP_PROC *cmp ));
1525
1526 LDAP_F( int )   /* deprecated */
1527 ldap_sort_values LDAP_P((
1528         LDAP *ld,
1529         char **vals,
1530         LDAP_SORT_AV_CMP_PROC *cmp ));
1531
1532 LDAP_F( int ) /* deprecated */
1533 ldap_sort_strcasecmp LDAP_P((
1534         LDAP_CONST void *a,
1535         LDAP_CONST void *b ));
1536
1537
1538 /*
1539  * in url.c
1540  *
1541  * need _ext varients
1542  */
1543 LDAP_F( int )
1544 ldap_is_ldap_url LDAP_P((
1545         LDAP_CONST char *url ));
1546
1547 LDAP_F( int )
1548 ldap_is_ldaps_url LDAP_P((
1549         LDAP_CONST char *url ));
1550
1551 LDAP_F( int )
1552 ldap_is_ldapi_url LDAP_P((
1553         LDAP_CONST char *url ));
1554
1555 LDAP_F( int )
1556 ldap_url_parse LDAP_P((
1557         LDAP_CONST char *url,
1558         LDAPURLDesc **ludpp ));
1559
1560 LDAP_F( void )
1561 ldap_free_urldesc LDAP_P((
1562         LDAPURLDesc *ludp ));
1563
1564 LDAP_F( int )
1565 ldap_url_search LDAP_P((
1566         LDAP *ld,
1567         LDAP_CONST char *url,
1568         int attrsonly ));
1569
1570 LDAP_F( int )
1571 ldap_url_search_s LDAP_P((
1572         LDAP *ld,
1573         LDAP_CONST char *url,
1574         int attrsonly,
1575         LDAPMessage **res ));
1576
1577 LDAP_F( int )
1578 ldap_url_search_st LDAP_P((
1579         LDAP *ld,
1580         LDAP_CONST char *url,
1581         int attrsonly,
1582         struct timeval *timeout,
1583         LDAPMessage **res ));
1584
1585 /*
1586  * in sortctrl.c
1587  */
1588 /*
1589  * structure for a sort-key
1590  */
1591 typedef struct ldapsortkey {
1592         char *  attributeType;
1593         char *  orderingRule;
1594         int     reverseOrder;
1595 } LDAPSortKey;
1596
1597 LDAP_F( int )
1598 ldap_create_sort_keylist LDAP_P((
1599         LDAPSortKey ***sortKeyList,
1600         char        *keyString ));
1601
1602 LDAP_F( void )
1603 ldap_free_sort_keylist LDAP_P((
1604         LDAPSortKey **sortkeylist ));
1605
1606 LDAP_F( int )
1607 ldap_create_sort_control LDAP_P((
1608         LDAP *ld,
1609         LDAPSortKey **keyList,
1610         int ctl_iscritical,
1611         LDAPControl **ctrlp ));
1612
1613 LDAP_F( int )
1614 ldap_parse_sort_control LDAP_P((
1615         LDAP           *ld,
1616         LDAPControl    **ctrlp,
1617         unsigned long  *result,
1618         char           **attribute ));
1619
1620
1621 /*
1622  * in vlvctrl.c
1623  */
1624
1625 /*
1626  * structure for virtul list.
1627  */
1628 typedef struct ldapvlvinfo {
1629         int             ldvlv_version;
1630     unsigned long   ldvlv_before_count;
1631     unsigned long   ldvlv_after_count;
1632     unsigned long   ldvlv_offset;
1633     unsigned long   ldvlv_count;
1634     struct berval  *ldvlv_attrvalue;
1635     struct berval  *ldvlv_context;
1636     void           *ldvlv_extradata;
1637 } LDAPVLVInfo;
1638
1639 LDAP_F( int )
1640 ldap_create_vlv_control LDAP_P((
1641         LDAP *ld,
1642         LDAPVLVInfo *ldvlistp,
1643         LDAPControl **ctrlp ));
1644
1645 LDAP_F( int )
1646 ldap_parse_vlv_control LDAP_P((
1647         LDAP          *ld,
1648         LDAPControl   **ctrls,
1649         unsigned long *target_posp,
1650         unsigned long *list_countp,
1651         struct berval **contextp,
1652         int           *errcodep ));
1653
1654
1655 LDAP_END_DECL
1656 #endif /* _LDAP_H */