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.1.11.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_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
 257 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
 258 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
 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_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
 272 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
 273 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* 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                ((char*)0)
 284
 285
 286 /* authentication methods available */
 287 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
 288 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
 289 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + primitive   */
 290 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
 291 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
 292 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
 293
 294
 295 /* filter types */
 296 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 297 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 298 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 299 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 300 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 301 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 302 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 303 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 304 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 305 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 306
 307 /* extended filter component types */
 308 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
 309 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 310 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 311 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 312
 313 /* substring filter component types */
 314 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 315 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 316 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 317
 318 /* search scopes */
 319 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 320 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 321 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 322
 323 /* substring filter component types */
 324 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 325 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 326 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 327
 328 /*
 329  * possible error codes we can return
 330  */
 331
 332 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 333
 334 #define LDAP_SUCCESS                    0x00
 335 #define LDAP_OPERATIONS_ERROR           0x01
 336 #define LDAP_PROTOCOL_ERROR             0x02
 337 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 338 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 339 #define LDAP_COMPARE_FALSE              0x05
 340 #define LDAP_COMPARE_TRUE               0x06
 341 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 342 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 343 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 344 #define LDAP_PARTIAL_RESULTS            0x09    /* not listed in v3 */
 345
 346 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 347 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 348 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 349 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 350 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 351
 352 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 353
 354 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 355 #define LDAP_UNDEFINED_TYPE             0x11
 356 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 357 #define LDAP_CONSTRAINT_VIOLATION       0x13
 358 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 359 #define LDAP_INVALID_SYNTAX             0x15
 360
 361 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 362
 363 #define LDAP_NO_SUCH_OBJECT             0x20
 364 #define LDAP_ALIAS_PROBLEM              0x21
 365 #define LDAP_INVALID_DN_SYNTAX          0x22
 366 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 367 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 368
 369 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
 370
 371 #define LDAP_INAPPROPRIATE_AUTH         0x30
 372 #define LDAP_INVALID_CREDENTIALS        0x31
 373 #define LDAP_INSUFFICIENT_ACCESS        0x32
 374
 375 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 376
 377 #define LDAP_BUSY                       0x33
 378 #define LDAP_UNAVAILABLE                0x34
 379 #define LDAP_UNWILLING_TO_PERFORM       0x35
 380 #define LDAP_LOOP_DETECT                0x36
 381
 382 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 383
 384 #define LDAP_NAMING_VIOLATION           0x40
 385 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 386 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 387 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 388 #define LDAP_ALREADY_EXISTS             0x44
 389 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 390 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 391 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 392
 393 #define LDAP_OTHER                      0x50
 394
 395 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 396
 397 #define LDAP_SERVER_DOWN                0x51
 398 #define LDAP_LOCAL_ERROR                0x52
 399 #define LDAP_ENCODING_ERROR             0x53
 400 #define LDAP_DECODING_ERROR             0x54
 401 #define LDAP_TIMEOUT                    0x55
 402 #define LDAP_AUTH_UNKNOWN               0x56
 403 #define LDAP_FILTER_ERROR               0x57
 404 #define LDAP_USER_CANCELLED             0x58
 405 #define LDAP_PARAM_ERROR                0x59
 406 #define LDAP_NO_MEMORY                  0x5a
 407
 408 /* not technically reserved for APIs */
 409 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 410 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 411 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 412 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 413 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 414 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 415 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 416
 417 /*
 418  * This structure represents both ldap messages and ldap responses.
 419  * These are really the same, except in the case of search responses,
 420  * where a response has multiple messages.
 421  */
 422
 423 typedef struct ldapmsg LDAPMessage;
 424
 425 /* for modifications */
 426 typedef struct ldapmod {
 427         int             mod_op;
 428
 429 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 430 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 431 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 432 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 433 /* IMPORTANT: do not use code 0x1000 (or above),
 434  * it is used internally by the backends!
 435  * (see ldap/servers/slapd/slap.h)
 436  */
 437
 438         char            *mod_type;
 439         union mod_vals_u {
 440                 char            **modv_strvals;
 441                 struct berval   **modv_bvals;
 442         } mod_vals;
 443 #define mod_values      mod_vals.modv_strvals
 444 #define mod_bvalues     mod_vals.modv_bvals
 445 } LDAPMod;
 446
 447 /*
 448  * structures for ldap getfilter routines
 449  */
 450
 451 typedef struct ldap_filt_info {
 452         char                    *lfi_filter;
 453         char                    *lfi_desc;
 454         int                     lfi_scope;
 455         int                     lfi_isexact;
 456         struct ldap_filt_info   *lfi_next;
 457 } LDAPFiltInfo;
 458
 459 typedef struct ldap_filt_list {
 460     char                        *lfl_tag;
 461     char                        *lfl_pattern;
 462     char                        *lfl_delims;
 463     LDAPFiltInfo                *lfl_ilist;
 464     struct ldap_filt_list       *lfl_next;
 465 } LDAPFiltList;
 466
 467
 468 #define LDAP_FILT_MAXSIZ        1024
 469
 470 typedef struct ldap_filt_desc {
 471         LDAPFiltList            *lfd_filtlist;
 472         LDAPFiltInfo            *lfd_curfip;
 473         LDAPFiltInfo            lfd_retfi;
 474         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 475         char                    *lfd_curval;
 476         char                    *lfd_curvalcopy;
 477         char                    **lfd_curvalwords;
 478         char                    *lfd_filtprefix;
 479         char                    *lfd_filtsuffix;
 480 } LDAPFiltDesc;
 481
 482
 483 /*
 484  * structure representing an ldap session which can
 485  * encompass connections to multiple servers (in the
 486  * face of referrals).
 487  */
 488 typedef struct ldap LDAP;
 489
 490 #define LDAP_DEREF_NEVER        0x00
 491 #define LDAP_DEREF_SEARCHING    0x01
 492 #define LDAP_DEREF_FINDING      0x02
 493 #define LDAP_DEREF_ALWAYS       0x03
 494
 495 #define LDAP_NO_LIMIT           0
 496
 497 /* how many messages to retrieve results for */
 498 #define LDAP_MSG_ONE            0x00
 499 #define LDAP_MSG_ALL            0x01
 500 #define LDAP_MSG_RECEIVED       0x02
 501
 502 /*
 503  * structure for ldap friendly mapping routines
 504  */
 505
 506 typedef struct ldap_friendly {
 507         char    *lf_unfriendly;
 508         char    *lf_friendly;
 509 } LDAPFriendlyMap;
 510
 511 /*
 512  * types for ldap URL handling
 513  */
 514 typedef struct ldap_url_desc {
 515     struct ldap_url_desc *lud_next;
 516     char        *lud_scheme;
 517     char        *lud_host;
 518     int         lud_port;
 519     char        *lud_dn;
 520     char        **lud_attrs;
 521     int         lud_scope;
 522     char        *lud_filter;
 523     char        **lud_exts;
 524 } LDAPURLDesc;
 525
 526 #define LDAP_URL_SUCCESS                0x00    /* Success */
 527 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 528 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 529
 530 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 531 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 532 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 533 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 534 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 535 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 536 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 537 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 538
 539 /*
 540  * The API draft spec says we should declare (or cause to be declared)
 541  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 542  */
 543 struct timeval;
 544
 545 /*
 546  * in options.c:
 547  */
 548 LDAP_F( int )
 549 ldap_get_option LDAP_P((
 550         LDAP *ld,
 551         int option,
 552         void *outvalue));
 553
 554 LDAP_F( int )
 555 ldap_set_option LDAP_P((
 556         LDAP *ld,
 557         int option,
 558         LDAP_CONST void *invalue));
 559
 560 /* V3 REBIND Function Callback Prototype */
 561 typedef int (LDAP_REBIND_PROC) LDAP_P((
 562         LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
 563
 564 LDAP_F( int )
 565 ldap_set_rebind_proc LDAP_P((
 566         LDAP *ld,
 567         LDAP_REBIND_PROC *ldap_proc));
 568
 569 /*
 570  * in controls.c:
 571  */
 572 LDAP_F( void )
 573 ldap_control_free LDAP_P((
 574         LDAPControl *ctrl ));
 575
 576 LDAP_F( void )
 577 ldap_controls_free LDAP_P((
 578         LDAPControl **ctrls ));
 579
 580 /*
 581  * in dnssrv.c:
 582  */
 583 LDAP_F( int )
 584 ldap_domain2dn LDAP_P((
 585         LDAP_CONST char* domain,
 586         char** dn ));
 587
 588 LDAP_F( int )
 589 ldap_dn2domain LDAP_P((
 590         LDAP_CONST char* dn,
 591         char** domain ));
 592
 593 LDAP_F( int )
 594 ldap_domain2hostlist LDAP_P((
 595         LDAP_CONST char *domain,
 596         char** hostlist ));
 597
 598 /*
 599  * in extended.c:
 600  */
 601 LDAP_F( int )
 602 ldap_extended_operation LDAP_P((
 603         LDAP                    *ld,
 604         LDAP_CONST char *reqoid,
 605         struct berval   *reqdata,
 606         LDAPControl             **serverctrls,
 607         LDAPControl             **clientctrls,
 608         int                             *msgidp ));
 609
 610 LDAP_F( int )
 611 ldap_extended_operation_s LDAP_P((
 612         LDAP                    *ld,
 613         LDAP_CONST char *reqoid,
 614         struct berval   *reqdata,
 615         LDAPControl             **serverctrls,
 616         LDAPControl             **clientctrls,
 617         char                    **retoidp,
 618         struct berval   **retdatap ));
 619
 620 LDAP_F( int )
 621 ldap_parse_extended_result LDAP_P((
 622         LDAP                    *ld,
 623         LDAPMessage             *res,
 624         char                    **retoidp,
 625         struct berval   **retdatap,
 626         int                             freeit ));
 627
 628 LDAP_F( int )
 629 ldap_parse_extended_partial LDAP_P((
 630         LDAP                    *ld,
 631         LDAPMessage             *res,
 632         char                    **retoidp,
 633         struct berval   **retdatap,
 634         LDAPControl             ***serverctrls,
 635         int                             freeit ));
 636
 637 /*
 638  * in abandon.c:
 639  */
 640 LDAP_F( int )
 641 ldap_abandon_ext LDAP_P((
 642         LDAP                    *ld,
 643         int                             msgid,
 644         LDAPControl             **serverctrls,
 645         LDAPControl             **clientctrls ));
 646
 647 LDAP_F( int )
 648 ldap_abandon LDAP_P((   /* deprecated */
 649         LDAP *ld,
 650         int msgid ));
 651
 652
 653 /*
 654  * in add.c:
 655  */
 656 LDAP_F( int )
 657 ldap_add_ext LDAP_P((
 658         LDAP                    *ld,
 659         LDAP_CONST char *dn,
 660         LDAPMod                 **attrs,
 661         LDAPControl             **serverctrls,
 662         LDAPControl             **clientctrls,
 663         int                     *msgidp ));
 664
 665 LDAP_F( int )
 666 ldap_add_ext_s LDAP_P((
 667         LDAP                    *ld,
 668         LDAP_CONST char *dn,
 669         LDAPMod                 **attrs,
 670         LDAPControl             **serverctrls,
 671         LDAPControl             **clientctrls ));
 672
 673 LDAP_F( int )
 674 ldap_add LDAP_P((       /* deprecated */
 675         LDAP *ld,
 676         LDAP_CONST char *dn,
 677         LDAPMod **attrs ));
 678
 679 LDAP_F( int )
 680 ldap_add_s LDAP_P((     /* deprecated */
 681         LDAP *ld,
 682         LDAP_CONST char *dn,
 683         LDAPMod **attrs ));
 684
 685
 686 /*
 687  * in sasl.c:
 688  */
 689 LDAP_F( int )
 690 ldap_sasl_bind LDAP_P((
 691         LDAP                    *ld,
 692         LDAP_CONST char *dn,
 693         LDAP_CONST char *mechanism,
 694         struct berval   *cred,
 695         LDAPControl             **serverctrls,
 696         LDAPControl             **clientctrls,
 697         int                             *msgidp ));
 698
 699 /* Interaction flags (should be passed about in a control)
 700  *  Automatic (default): use defaults, prompt otherwise
 701  *  Interactive: prompt always
 702  *  Quiet: never prompt
 703  */
 704 #define LDAP_SASL_AUTOMATIC             0U
 705 #define LDAP_SASL_INTERACTIVE   1U
 706 #define LDAP_SASL_QUIET                 2U
 707
 708 /*
 709  * V3 SASL Interaction Function Callback Prototype
 710  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 711  *  should likely passed in a control (and provided controls)
 712  */
 713 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 714         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 715
 716 LDAP_F( int )
 717 ldap_sasl_interactive_bind_s LDAP_P((
 718         LDAP *ld,
 719         LDAP_CONST char *dn, /* usually NULL */
 720         LDAP_CONST char *saslMechanism,
 721         LDAPControl **serverControls,
 722         LDAPControl **clientControls,
 723
 724         /* should be client controls */
 725         unsigned flags,
 726         LDAP_SASL_INTERACT_PROC *proc,
 727         void *defaults ));
 728
 729 LDAP_F( int )
 730 ldap_sasl_bind_s LDAP_P((
 731         LDAP                    *ld,
 732         LDAP_CONST char *dn,
 733         LDAP_CONST char *mechanism,
 734         struct berval   *cred,
 735         LDAPControl             **serverctrls,
 736         LDAPControl             **clientctrls,
 737         struct berval   **servercredp ));
 738
 739 LDAP_F( int )
 740 ldap_parse_sasl_bind_result LDAP_P((
 741         LDAP                    *ld,
 742         LDAPMessage             *res,
 743         struct berval   **servercredp,
 744         int                             freeit ));
 745
 746 /*
 747  * in bind.c:
 748  *      (deprecated)
 749  */
 750 LDAP_F( int )
 751 ldap_bind LDAP_P((      /* deprecated */
 752         LDAP *ld,
 753         LDAP_CONST char *who,
 754         LDAP_CONST char *passwd,
 755         int authmethod ));
 756
 757 LDAP_F( int )
 758 ldap_bind_s LDAP_P((    /* deprecated */
 759         LDAP *ld,
 760         LDAP_CONST char *who,
 761         LDAP_CONST char *cred,
 762         int authmethod ));
 763
 764 /*
 765  * in sbind.c:
 766  */
 767 LDAP_F( int )
 768 ldap_simple_bind LDAP_P((
 769         LDAP *ld,
 770         LDAP_CONST char *who,
 771         LDAP_CONST char *passwd ));
 772
 773 LDAP_F( int )
 774 ldap_simple_bind_s LDAP_P((
 775         LDAP *ld,
 776         LDAP_CONST char *who,
 777         LDAP_CONST char *passwd ));
 778
 779
 780 /*
 781  * in kbind.c:
 782  *      (deprecated)
 783  */
 784 LDAP_F( int )
 785 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 786         LDAP *ld,
 787         LDAP_CONST char *who ));
 788
 789 LDAP_F( int )
 790 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 791         LDAP *ld,
 792         LDAP_CONST char *who ));
 793
 794 LDAP_F( int )
 795 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 796         LDAP *ld,
 797         LDAP_CONST char *who ));
 798
 799 LDAP_F( int )
 800 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 801         LDAP *ld,
 802         LDAP_CONST char *who ));
 803
 804 LDAP_F( int )
 805 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 806         LDAP *ld,
 807         LDAP_CONST char *who ));
 808
 809 /*
 810  * in cache.c
 811  * (deprecated)
 812  */
 813 LDAP_F( int )
 814 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 815
 816 LDAP_F( void )
 817 ldap_disable_cache LDAP_P(( LDAP *ld ));
 818
 819 LDAP_F( void )
 820 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 821
 822 LDAP_F( void )
 823 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 824
 825 LDAP_F( void )
 826 ldap_flush_cache LDAP_P(( LDAP *ld ));
 827
 828 LDAP_F( void )
 829 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 830
 831 LDAP_F( void )
 832 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 833
 834
 835 /*
 836  * in compare.c:
 837  */
 838 LDAP_F( int )
 839 ldap_compare_ext LDAP_P((
 840         LDAP                    *ld,
 841         LDAP_CONST char *dn,
 842         LDAP_CONST char *attr,
 843         struct berval   *bvalue,
 844         LDAPControl             **serverctrls,
 845         LDAPControl             **clientctrls,
 846         int                     *msgidp ));
 847
 848 LDAP_F( int )
 849 ldap_compare_ext_s LDAP_P((
 850         LDAP                    *ld,
 851         LDAP_CONST char *dn,
 852         LDAP_CONST char *attr,
 853         struct berval   *bvalue,
 854         LDAPControl             **serverctrls,
 855         LDAPControl             **clientctrls ));
 856
 857 LDAP_F( int )
 858 ldap_compare LDAP_P((   /* deprecated */
 859         LDAP *ld,
 860         LDAP_CONST char *dn,
 861         LDAP_CONST char *attr,
 862         LDAP_CONST char *value ));
 863
 864 LDAP_F( int )
 865 ldap_compare_s LDAP_P(( /* deprecated */
 866         LDAP *ld,
 867         LDAP_CONST char *dn,
 868         LDAP_CONST char *attr,
 869         LDAP_CONST char *value ));
 870
 871
 872 /*
 873  * in delete.c:
 874  */
 875 LDAP_F( int )
 876 ldap_delete_ext LDAP_P((
 877         LDAP                    *ld,
 878         LDAP_CONST char *dn,
 879         LDAPControl             **serverctrls,
 880         LDAPControl             **clientctrls,
 881         int                     *msgidp ));
 882
 883 LDAP_F( int )
 884 ldap_delete_ext_s LDAP_P((
 885         LDAP                    *ld,
 886         LDAP_CONST char *dn,
 887         LDAPControl             **serverctrls,
 888         LDAPControl             **clientctrls ));
 889
 890 LDAP_F( int )
 891 ldap_delete LDAP_P((    /* deprecated */
 892         LDAP *ld,
 893         LDAP_CONST char *dn ));
 894
 895 LDAP_F( int )
 896 ldap_delete_s LDAP_P((  /* deprecated */
 897         LDAP *ld,
 898         LDAP_CONST char *dn ));
 899
 900
 901 /*
 902  * in error.c:
 903  */
 904 LDAP_F( int )
 905 ldap_parse_result LDAP_P((
 906         LDAP                    *ld,
 907         LDAPMessage             *res,
 908         int                             *errcodep,
 909         char                    **matcheddnp,
 910         char                    **errmsgp,
 911         char                    ***referralsp,
 912         LDAPControl             ***serverctrls,
 913         int                             freeit ));
 914
 915 LDAP_F( char *)
 916 ldap_err2string LDAP_P((
 917         int err ));
 918
 919 LDAP_F( int )
 920 ldap_result2error LDAP_P((      /* deprecated */
 921         LDAP *ld,
 922         LDAPMessage *r,
 923         int freeit ));
 924
 925 LDAP_F( void )
 926 ldap_perror LDAP_P((    /* deprecated */
 927         LDAP *ld,
 928         LDAP_CONST char *s ));
 929
 930
 931 /*
 932  * in modify.c:
 933  */
 934 LDAP_F( int )
 935 ldap_modify_ext LDAP_P((
 936         LDAP                    *ld,
 937         LDAP_CONST char *dn,
 938         LDAPMod                 **mods,
 939         LDAPControl             **serverctrls,
 940         LDAPControl             **clientctrls,
 941         int                     *msgidp ));
 942
 943 LDAP_F( int )
 944 ldap_modify_ext_s LDAP_P((
 945         LDAP                    *ld,
 946         LDAP_CONST char *dn,
 947         LDAPMod                 **mods,
 948         LDAPControl             **serverctrls,
 949         LDAPControl             **clientctrls ));
 950
 951 LDAP_F( int )
 952 ldap_modify LDAP_P((    /* deprecated */
 953         LDAP *ld,
 954         LDAP_CONST char *dn,
 955         LDAPMod **mods ));
 956
 957 LDAP_F( int )
 958 ldap_modify_s LDAP_P((  /* deprecated */
 959         LDAP *ld,
 960         LDAP_CONST char *dn,
 961         LDAPMod **mods ));
 962
 963
 964 /*
 965  * in modrdn.c:
 966  */
 967 LDAP_F( int )
 968 ldap_rename LDAP_P((
 969         LDAP *ld,
 970         LDAP_CONST char *dn,
 971         LDAP_CONST char *newrdn,
 972         LDAP_CONST char *newSuperior,
 973         int deleteoldrdn,
 974         LDAPControl **sctrls,
 975         LDAPControl **cctrls,
 976         int *msgidp ));
 977
 978 LDAP_F( int )
 979 ldap_rename_s LDAP_P((
 980         LDAP *ld,
 981         LDAP_CONST char *dn,
 982         LDAP_CONST char *newrdn,
 983         LDAP_CONST char *newSuperior,
 984         int deleteoldrdn,
 985         LDAPControl **sctrls,
 986         LDAPControl **cctrls ));
 987
 988 LDAP_F( int )
 989 ldap_rename2 LDAP_P((   /* deprecated */
 990         LDAP *ld,
 991         LDAP_CONST char *dn,
 992         LDAP_CONST char *newrdn,
 993         LDAP_CONST char *newSuperior,
 994         int deleteoldrdn ));
 995
 996 LDAP_F( int )
 997 ldap_rename2_s LDAP_P(( /* deprecated */
 998         LDAP *ld,
 999         LDAP_CONST char *dn,
1000         LDAP_CONST char *newrdn,
1001         LDAP_CONST char *newSuperior,
1002         int deleteoldrdn ));
1003
1004 LDAP_F( int )
1005 ldap_modrdn LDAP_P((    /* deprecated */
1006         LDAP *ld,
1007         LDAP_CONST char *dn,
1008         LDAP_CONST char *newrdn ));
1009
1010 LDAP_F( int )
1011 ldap_modrdn_s LDAP_P((  /* deprecated */
1012         LDAP *ld,
1013         LDAP_CONST char *dn,
1014         LDAP_CONST char *newrdn ));
1015
1016 LDAP_F( int )
1017 ldap_modrdn2 LDAP_P((   /* deprecated */
1018         LDAP *ld,
1019         LDAP_CONST char *dn,
1020         LDAP_CONST char *newrdn,
1021         int deleteoldrdn ));
1022
1023 LDAP_F( int )
1024 ldap_modrdn2_s LDAP_P(( /* deprecated */
1025         LDAP *ld,
1026         LDAP_CONST char *dn,
1027         LDAP_CONST char *newrdn,
1028         int deleteoldrdn));
1029
1030
1031 /*
1032  * in open.c:
1033  */
1034 LDAP_F( LDAP *)
1035 ldap_init LDAP_P((
1036         LDAP_CONST char *host,
1037         int port ));
1038
1039 LDAP_F( LDAP *)
1040 ldap_open LDAP_P((      /* deprecated */
1041         LDAP_CONST char *host,
1042         int port ));
1043
1044 LDAP_F( int )
1045 ldap_create LDAP_P((
1046         LDAP **ldp ));
1047
1048 LDAP_F( int )
1049 ldap_initialize LDAP_P((
1050         LDAP **ldp,
1051         LDAP_CONST char *url ));
1052
1053 LDAP_F( int )
1054 ldap_start_tls_s LDAP_P((
1055         LDAP *ld,
1056         LDAPControl **serverctrls,
1057         LDAPControl **clientctrls ));
1058
1059 /*
1060  * in messages.c:
1061  */
1062 LDAP_F( LDAPMessage *)
1063 ldap_first_message LDAP_P((
1064         LDAP *ld,
1065         LDAPMessage *chain ));
1066
1067 LDAP_F( LDAPMessage *)
1068 ldap_next_message LDAP_P((
1069         LDAP *ld,
1070         LDAPMessage *msg ));
1071
1072 LDAP_F( int )
1073 ldap_count_messages LDAP_P((
1074         LDAP *ld,
1075         LDAPMessage *chain ));
1076
1077
1078 /*
1079  * in references.c:
1080  */
1081 LDAP_F( LDAPMessage *)
1082 ldap_first_reference LDAP_P((
1083         LDAP *ld,
1084         LDAPMessage *chain ));
1085
1086 LDAP_F( LDAPMessage *)
1087 ldap_next_reference LDAP_P((
1088         LDAP *ld,
1089         LDAPMessage *ref ));
1090
1091 LDAP_F( int )
1092 ldap_count_references LDAP_P((
1093         LDAP *ld,
1094         LDAPMessage *chain ));
1095
1096 LDAP_F( int )
1097 ldap_parse_reference LDAP_P((
1098         LDAP                    *ld,
1099         LDAPMessage             *ref,
1100         char                    ***referralsp,
1101         LDAPControl             ***serverctrls,
1102         int                             freeit));
1103
1104
1105 /*
1106  * in getentry.c:
1107  */
1108 LDAP_F( LDAPMessage *)
1109 ldap_first_entry LDAP_P((
1110         LDAP *ld,
1111         LDAPMessage *chain ));
1112
1113 LDAP_F( LDAPMessage *)
1114 ldap_next_entry LDAP_P((
1115         LDAP *ld,
1116         LDAPMessage *entry ));
1117
1118 LDAP_F( int )
1119 ldap_count_entries LDAP_P((
1120         LDAP *ld,
1121         LDAPMessage *chain ));
1122
1123 LDAP_F( int )
1124 ldap_get_entry_controls LDAP_P((
1125         LDAP                    *ld,
1126         LDAPMessage             *entry,
1127         LDAPControl             ***serverctrls));
1128
1129
1130 /*
1131  * in addentry.c
1132  */
1133 LDAP_F( LDAPMessage *)
1134 ldap_delete_result_entry LDAP_P((
1135         LDAPMessage **list,
1136         LDAPMessage *e ));
1137
1138 LDAP_F( void )
1139 ldap_add_result_entry LDAP_P((
1140         LDAPMessage **list,
1141         LDAPMessage *e ));
1142
1143
1144 /*
1145  * in getdn.c
1146  */
1147 LDAP_F( char * )
1148 ldap_get_dn LDAP_P((
1149         LDAP *ld,
1150         LDAPMessage *entry ));
1151
1152 LDAP_F( char * )
1153 ldap_dn2ufn LDAP_P((
1154         LDAP_CONST char *dn ));
1155
1156 LDAP_F( char ** )
1157 ldap_explode_dn LDAP_P((
1158         LDAP_CONST char *dn,
1159         int notypes ));
1160
1161 LDAP_F( char ** )
1162 ldap_explode_rdn LDAP_P((
1163         LDAP_CONST char *rdn,
1164         int notypes ));
1165
1166 LDAP_F( char * )
1167 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1168
1169 LDAP_F( char * )
1170 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1171
1172 /*
1173  * in getattr.c
1174  */
1175 LDAP_F( char *)
1176 ldap_first_attribute LDAP_P((
1177         LDAP *ld,
1178         LDAPMessage *entry,
1179         BerElement **ber ));
1180
1181 LDAP_F( char *)
1182 ldap_next_attribute LDAP_P((
1183         LDAP *ld,
1184         LDAPMessage *entry,
1185         BerElement *ber ));
1186
1187
1188 /*
1189  * in getvalues.c
1190  */
1191 LDAP_F( char **)
1192 ldap_get_values LDAP_P((
1193         LDAP *ld,
1194         LDAPMessage *entry,
1195         LDAP_CONST char *target ));
1196
1197 LDAP_F( struct berval **)
1198 ldap_get_values_len LDAP_P((
1199         LDAP *ld,
1200         LDAPMessage *entry,
1201         LDAP_CONST char *target ));
1202
1203 LDAP_F( int )
1204 ldap_count_values LDAP_P((
1205         char **vals ));
1206
1207 LDAP_F( int )
1208 ldap_count_values_len LDAP_P((
1209         struct berval **vals ));
1210
1211 LDAP_F( void )
1212 ldap_value_free LDAP_P((
1213         char **vals ));
1214
1215 LDAP_F( void )
1216 ldap_value_free_len LDAP_P((
1217         struct berval **vals ));
1218
1219 /*
1220  * in result.c:
1221  */
1222 LDAP_F( int )
1223 ldap_result LDAP_P((
1224         LDAP *ld,
1225         int msgid,
1226         int all,
1227         struct timeval *timeout,
1228         LDAPMessage **result ));
1229
1230 LDAP_F( int )
1231 ldap_msgtype LDAP_P((
1232         LDAPMessage *lm ));
1233
1234 LDAP_F( int )
1235 ldap_msgid   LDAP_P((
1236         LDAPMessage *lm ));
1237
1238 LDAP_F( int )
1239 ldap_msgfree LDAP_P((
1240         LDAPMessage *lm ));
1241
1242 LDAP_F( int )
1243 ldap_msgdelete LDAP_P((
1244         LDAP *ld,
1245         int msgid ));
1246
1247
1248 /*
1249  * in search.c:
1250  */
1251 LDAP_F( int )
1252 ldap_search_ext LDAP_P((
1253         LDAP                    *ld,
1254         LDAP_CONST char *base,
1255         int                             scope,
1256         LDAP_CONST char *filter,
1257         char                    **attrs,
1258         int                             attrsonly,
1259         LDAPControl             **serverctrls,
1260         LDAPControl             **clientctrls,
1261         struct timeval  *timeout,
1262         int                             sizelimit,
1263         int                             *msgidp ));
1264
1265 LDAP_F( int )
1266 ldap_search_ext_s LDAP_P((
1267         LDAP                    *ld,
1268         LDAP_CONST char *base,
1269         int                             scope,
1270         LDAP_CONST char *filter,
1271         char                    **attrs,
1272         int                             attrsonly,
1273         LDAPControl             **serverctrls,
1274         LDAPControl             **clientctrls,
1275         struct timeval  *timeout,
1276         int                             sizelimit,
1277         LDAPMessage             **res ));
1278
1279 LDAP_F( int )
1280 ldap_search LDAP_P((    /* deprecated */
1281         LDAP *ld,
1282         LDAP_CONST char *base,
1283         int scope,
1284         LDAP_CONST char *filter,
1285         char **attrs,
1286         int attrsonly ));
1287
1288 LDAP_F( int )
1289 ldap_search_s LDAP_P((  /* deprecated */
1290         LDAP *ld,
1291         LDAP_CONST char *base,
1292         int scope,
1293         LDAP_CONST char *filter,
1294         char **attrs,
1295         int attrsonly,
1296         LDAPMessage **res ));
1297
1298 LDAP_F( int )
1299 ldap_search_st LDAP_P(( /* deprecated */
1300         LDAP *ld,
1301         LDAP_CONST char *base,
1302         int scope,
1303         LDAP_CONST char *filter,
1304     char **attrs,
1305         int attrsonly,
1306         struct timeval *timeout,
1307         LDAPMessage **res ));
1308
1309
1310 /*
1311  * in ufn.c
1312  *      (deprecated)
1313  */
1314 LDAP_F( int )
1315 ldap_ufn_search_c LDAP_P(( /* deprecated */
1316         LDAP *ld,
1317         LDAP_CONST char *ufn,
1318         char **attrs,
1319         int attrsonly,
1320         LDAPMessage **res,
1321         int (*cancelproc)( void *cl ),
1322         void *cancelparm ));
1323
1324 LDAP_F( int )
1325 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1326         LDAP *ld,
1327         LDAP_CONST char *ufn,
1328         char **attrs,
1329         int attrsonly,
1330         LDAPMessage **res,
1331         int (*cancelproc)( void *cl ),
1332         void *cancelparm,
1333         char *tag1,
1334         char *tag2,
1335         char *tag3 ));
1336
1337 LDAP_F( int )
1338 ldap_ufn_search_s LDAP_P(( /* deprecated */
1339         LDAP *ld,
1340         LDAP_CONST char *ufn,
1341         char **attrs,
1342         int attrsonly,
1343         LDAPMessage **res ));
1344
1345 LDAP_F( LDAPFiltDesc *)
1346 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1347         LDAP *ld,
1348         LDAP_CONST char *fname ));
1349
1350 LDAP_F( void )
1351 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1352         LDAP *ld,
1353         LDAP_CONST char *prefix ));
1354
1355 LDAP_F( int )
1356 ldap_ufn_timeout LDAP_P(( /* deprecated */
1357         void *tvparam ));
1358
1359
1360 /*
1361  * in unbind.c
1362  */
1363 LDAP_F( int )
1364 ldap_unbind LDAP_P(( /* deprecated */
1365         LDAP *ld ));
1366
1367 LDAP_F( int )
1368 ldap_unbind_s LDAP_P(( /* deprecated */
1369         LDAP *ld ));
1370
1371 LDAP_F( int )
1372 ldap_unbind_ext LDAP_P((
1373         LDAP                    *ld,
1374         LDAPControl             **serverctrls,
1375         LDAPControl             **clientctrls));
1376
1377 LDAP_F( int )
1378 ldap_unbind_ext_s LDAP_P((
1379         LDAP                    *ld,
1380         LDAPControl             **serverctrls,
1381         LDAPControl             **clientctrls));
1382
1383 /*
1384  * in getfilter.c
1385  *      (deprecated)
1386  */
1387 LDAP_F( LDAPFiltDesc *)
1388 ldap_init_getfilter LDAP_P(( /* deprecated */
1389         LDAP_CONST char *fname ));
1390
1391 LDAP_F( LDAPFiltDesc *)
1392 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1393         /* LDAP_CONST */ char *buf,
1394         ber_len_t buflen ));
1395
1396 LDAP_F( LDAPFiltInfo *)
1397 ldap_getfirstfilter LDAP_P(( /* deprecated */
1398         LDAPFiltDesc *lfdp,
1399         /* LDAP_CONST */ char *tagpat,
1400         /* LDAP_CONST */ char *value ));
1401
1402 LDAP_F( LDAPFiltInfo *)
1403 ldap_getnextfilter LDAP_P(( /* deprecated */
1404         LDAPFiltDesc *lfdp ));
1405
1406 LDAP_F( void )
1407 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1408         LDAPFiltDesc *lfdp,
1409         LDAP_CONST char *prefix,
1410         LDAP_CONST char *suffix ));
1411
1412 LDAP_F( void )
1413 ldap_build_filter LDAP_P(( /* deprecated */
1414         char *buf,
1415         ber_len_t buflen,
1416         LDAP_CONST char *pattern,
1417         LDAP_CONST char *prefix,
1418         LDAP_CONST char *suffix,
1419         LDAP_CONST char *attr,
1420         LDAP_CONST char *value,
1421         char **valwords ));
1422
1423
1424 /*
1425  * in free.c
1426  */
1427
1428 LDAP_F( void * )
1429 ldap_memalloc LDAP_P((
1430         ber_len_t s ));
1431
1432 LDAP_F( void * )
1433 ldap_memrealloc LDAP_P((
1434         void* p,
1435         ber_len_t s ));
1436
1437 LDAP_F( void * )
1438 ldap_memcalloc LDAP_P((
1439         ber_len_t n,
1440         ber_len_t s ));
1441
1442 LDAP_F( void )
1443 ldap_memfree LDAP_P((
1444         void* p ));
1445
1446 LDAP_F( void )
1447 ldap_memvfree LDAP_P((
1448         void** v ));
1449
1450 LDAP_F( char * )
1451 ldap_strdup LDAP_P((
1452         LDAP_CONST char * ));
1453
1454 LDAP_F( void )
1455 ldap_getfilter_free LDAP_P((
1456         LDAPFiltDesc *lfdp ));
1457
1458 LDAP_F( void )
1459 ldap_mods_free LDAP_P((
1460         LDAPMod **mods,
1461         int freemods ));
1462
1463
1464 /*
1465  * in friendly.c
1466  *      (deprecated)
1467  */
1468 LDAP_F( char * )
1469 ldap_friendly_name LDAP_P(( /* deprecated */
1470         LDAP_CONST char *filename,
1471         /* LDAP_CONST */ char *uname,
1472         LDAPFriendlyMap **map ));
1473
1474 LDAP_F( void )
1475 ldap_free_friendlymap LDAP_P(( /* deprecated */
1476         LDAPFriendlyMap **map ));
1477
1478
1479 /*
1480  * in cldap.c
1481  *      (deprecated)
1482  */
1483 LDAP_F( LDAP * )
1484 cldap_open LDAP_P((     /* deprecated */
1485         LDAP_CONST char *host,
1486         int port ));
1487
1488 LDAP_F( void )
1489 cldap_close LDAP_P((    /* deprecated */
1490         LDAP *ld ));
1491
1492 LDAP_F( int )
1493 cldap_search_s LDAP_P(( /* deprecated */
1494         LDAP *ld,
1495         LDAP_CONST char *base,
1496         int scope,
1497         LDAP_CONST char *filter,
1498         char **attrs,
1499         int attrsonly,
1500         LDAPMessage **res,
1501         char *logdn ));
1502
1503 LDAP_F( void )
1504 cldap_setretryinfo LDAP_P(( /* deprecated */
1505         LDAP *ld,
1506         int tries,
1507         int timeout ));
1508
1509
1510 /*
1511  * in sort.c
1512  */
1513 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1514         LDAP_CONST char *left,
1515         LDAP_CONST char *right ));
1516
1517 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1518         LDAP_CONST void *left,
1519         LDAP_CONST void *right ));
1520
1521 LDAP_F( int )
1522 ldap_sort_entries LDAP_P(( LDAP *ld,
1523         LDAPMessage **chain,
1524         LDAP_CONST char *attr,
1525         LDAP_SORT_AD_CMP_PROC *cmp ));
1526
1527 LDAP_F( int )   /* deprecated */
1528 ldap_sort_values LDAP_P((
1529         LDAP *ld,
1530         char **vals,
1531         LDAP_SORT_AV_CMP_PROC *cmp ));
1532
1533 LDAP_F( int ) /* deprecated */
1534 ldap_sort_strcasecmp LDAP_P((
1535         LDAP_CONST void *a,
1536         LDAP_CONST void *b ));
1537
1538
1539 /*
1540  * in url.c
1541  *
1542  * need _ext varients
1543  */
1544 LDAP_F( int )
1545 ldap_is_ldap_url LDAP_P((
1546         LDAP_CONST char *url ));
1547
1548 LDAP_F( int )
1549 ldap_is_ldaps_url LDAP_P((
1550         LDAP_CONST char *url ));
1551
1552 LDAP_F( int )
1553 ldap_is_ldapi_url LDAP_P((
1554         LDAP_CONST char *url ));
1555
1556 LDAP_F( int )
1557 ldap_url_parse LDAP_P((
1558         LDAP_CONST char *url,
1559         LDAPURLDesc **ludpp ));
1560
1561 LDAP_F( void )
1562 ldap_free_urldesc LDAP_P((
1563         LDAPURLDesc *ludp ));
1564
1565 LDAP_F( int )
1566 ldap_url_search LDAP_P((
1567         LDAP *ld,
1568         LDAP_CONST char *url,
1569         int attrsonly ));
1570
1571 LDAP_F( int )
1572 ldap_url_search_s LDAP_P((
1573         LDAP *ld,
1574         LDAP_CONST char *url,
1575         int attrsonly,
1576         LDAPMessage **res ));
1577
1578 LDAP_F( int )
1579 ldap_url_search_st LDAP_P((
1580         LDAP *ld,
1581         LDAP_CONST char *url,
1582         int attrsonly,
1583         struct timeval *timeout,
1584         LDAPMessage **res ));
1585
1586 /*
1587  * in sortctrl.c
1588  */
1589 /*
1590  * structure for a sort-key
1591  */
1592 typedef struct ldapsortkey {
1593         char *  attributeType;
1594         char *  orderingRule;
1595         int     reverseOrder;
1596 } LDAPSortKey;
1597
1598 LDAP_F( int )
1599 ldap_create_sort_keylist LDAP_P((
1600         LDAPSortKey ***sortKeyList,
1601         char        *keyString ));
1602
1603 LDAP_F( void )
1604 ldap_free_sort_keylist LDAP_P((
1605         LDAPSortKey **sortkeylist ));
1606
1607 LDAP_F( int )
1608 ldap_create_sort_control LDAP_P((
1609         LDAP *ld,
1610         LDAPSortKey **keyList,
1611         int ctl_iscritical,
1612         LDAPControl **ctrlp ));
1613
1614 LDAP_F( int )
1615 ldap_parse_sort_control LDAP_P((
1616         LDAP           *ld,
1617         LDAPControl    **ctrlp,
1618         unsigned long  *result,
1619         char           **attribute ));
1620
1621
1622 /*
1623  * in vlvctrl.c
1624  */
1625
1626 /*
1627  * structure for virtul list.
1628  */
1629 typedef struct ldapvlvinfo {
1630         int             ldvlv_version;
1631     unsigned long   ldvlv_before_count;
1632     unsigned long   ldvlv_after_count;
1633     unsigned long   ldvlv_offset;
1634     unsigned long   ldvlv_count;
1635     struct berval  *ldvlv_attrvalue;
1636     struct berval  *ldvlv_context;
1637     void           *ldvlv_extradata;
1638 } LDAPVLVInfo;
1639
1640 LDAP_F( int )
1641 ldap_create_vlv_control LDAP_P((
1642         LDAP *ld,
1643         LDAPVLVInfo *ldvlistp,
1644         LDAPControl **ctrlp ));
1645
1646 LDAP_F( int )
1647 ldap_parse_vlv_control LDAP_P((
1648         LDAP          *ld,
1649         LDAPControl   **ctrls,
1650         unsigned long *target_posp,
1651         unsigned long *list_countp,
1652         struct berval **contextp,
1653         int           *errcodep ));
1654
1655
1656 LDAP_END_DECL
1657 #endif /* _LDAP_H */