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( int )
 573 ldap_create_control LDAP_P((
 574         const char *requestOID,
 575         BerElement *ber,
 576         int iscritical,
 577         LDAPControl **ctrlp ));
 578
 579 LDAP_F( void )
 580 ldap_control_free LDAP_P((
 581         LDAPControl *ctrl ));
 582
 583 LDAP_F( void )
 584 ldap_controls_free LDAP_P((
 585         LDAPControl **ctrls ));
 586
 587 /*
 588  * in dnssrv.c:
 589  */
 590 LDAP_F( int )
 591 ldap_domain2dn LDAP_P((
 592         LDAP_CONST char* domain,
 593         char** dn ));
 594
 595 LDAP_F( int )
 596 ldap_dn2domain LDAP_P((
 597         LDAP_CONST char* dn,
 598         char** domain ));
 599
 600 LDAP_F( int )
 601 ldap_domain2hostlist LDAP_P((
 602         LDAP_CONST char *domain,
 603         char** hostlist ));
 604
 605 /*
 606  * in extended.c:
 607  */
 608 LDAP_F( int )
 609 ldap_extended_operation LDAP_P((
 610         LDAP                    *ld,
 611         LDAP_CONST char *reqoid,
 612         struct berval   *reqdata,
 613         LDAPControl             **serverctrls,
 614         LDAPControl             **clientctrls,
 615         int                             *msgidp ));
 616
 617 LDAP_F( int )
 618 ldap_extended_operation_s LDAP_P((
 619         LDAP                    *ld,
 620         LDAP_CONST char *reqoid,
 621         struct berval   *reqdata,
 622         LDAPControl             **serverctrls,
 623         LDAPControl             **clientctrls,
 624         char                    **retoidp,
 625         struct berval   **retdatap ));
 626
 627 LDAP_F( int )
 628 ldap_parse_extended_result LDAP_P((
 629         LDAP                    *ld,
 630         LDAPMessage             *res,
 631         char                    **retoidp,
 632         struct berval   **retdatap,
 633         int                             freeit ));
 634
 635 LDAP_F( int )
 636 ldap_parse_extended_partial LDAP_P((
 637         LDAP                    *ld,
 638         LDAPMessage             *res,
 639         char                    **retoidp,
 640         struct berval   **retdatap,
 641         LDAPControl             ***serverctrls,
 642         int                             freeit ));
 643
 644 /*
 645  * in abandon.c:
 646  */
 647 LDAP_F( int )
 648 ldap_abandon_ext LDAP_P((
 649         LDAP                    *ld,
 650         int                             msgid,
 651         LDAPControl             **serverctrls,
 652         LDAPControl             **clientctrls ));
 653
 654 LDAP_F( int )
 655 ldap_abandon LDAP_P((   /* deprecated */
 656         LDAP *ld,
 657         int msgid ));
 658
 659
 660 /*
 661  * in add.c:
 662  */
 663 LDAP_F( int )
 664 ldap_add_ext LDAP_P((
 665         LDAP                    *ld,
 666         LDAP_CONST char *dn,
 667         LDAPMod                 **attrs,
 668         LDAPControl             **serverctrls,
 669         LDAPControl             **clientctrls,
 670         int                     *msgidp ));
 671
 672 LDAP_F( int )
 673 ldap_add_ext_s LDAP_P((
 674         LDAP                    *ld,
 675         LDAP_CONST char *dn,
 676         LDAPMod                 **attrs,
 677         LDAPControl             **serverctrls,
 678         LDAPControl             **clientctrls ));
 679
 680 LDAP_F( int )
 681 ldap_add LDAP_P((       /* deprecated */
 682         LDAP *ld,
 683         LDAP_CONST char *dn,
 684         LDAPMod **attrs ));
 685
 686 LDAP_F( int )
 687 ldap_add_s LDAP_P((     /* deprecated */
 688         LDAP *ld,
 689         LDAP_CONST char *dn,
 690         LDAPMod **attrs ));
 691
 692
 693 /*
 694  * in sasl.c:
 695  */
 696 LDAP_F( int )
 697 ldap_sasl_bind LDAP_P((
 698         LDAP                    *ld,
 699         LDAP_CONST char *dn,
 700         LDAP_CONST char *mechanism,
 701         struct berval   *cred,
 702         LDAPControl             **serverctrls,
 703         LDAPControl             **clientctrls,
 704         int                             *msgidp ));
 705
 706 /* Interaction flags (should be passed about in a control)
 707  *  Automatic (default): use defaults, prompt otherwise
 708  *  Interactive: prompt always
 709  *  Quiet: never prompt
 710  */
 711 #define LDAP_SASL_AUTOMATIC             0U
 712 #define LDAP_SASL_INTERACTIVE   1U
 713 #define LDAP_SASL_QUIET                 2U
 714
 715 /*
 716  * V3 SASL Interaction Function Callback Prototype
 717  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 718  *  should likely passed in a control (and provided controls)
 719  */
 720 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 721         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 722
 723 LDAP_F( int )
 724 ldap_sasl_interactive_bind_s LDAP_P((
 725         LDAP *ld,
 726         LDAP_CONST char *dn, /* usually NULL */
 727         LDAP_CONST char *saslMechanism,
 728         LDAPControl **serverControls,
 729         LDAPControl **clientControls,
 730
 731         /* should be client controls */
 732         unsigned flags,
 733         LDAP_SASL_INTERACT_PROC *proc,
 734         void *defaults ));
 735
 736 LDAP_F( int )
 737 ldap_sasl_bind_s LDAP_P((
 738         LDAP                    *ld,
 739         LDAP_CONST char *dn,
 740         LDAP_CONST char *mechanism,
 741         struct berval   *cred,
 742         LDAPControl             **serverctrls,
 743         LDAPControl             **clientctrls,
 744         struct berval   **servercredp ));
 745
 746 LDAP_F( int )
 747 ldap_parse_sasl_bind_result LDAP_P((
 748         LDAP                    *ld,
 749         LDAPMessage             *res,
 750         struct berval   **servercredp,
 751         int                             freeit ));
 752
 753 /*
 754  * in bind.c:
 755  *      (deprecated)
 756  */
 757 LDAP_F( int )
 758 ldap_bind LDAP_P((      /* deprecated */
 759         LDAP *ld,
 760         LDAP_CONST char *who,
 761         LDAP_CONST char *passwd,
 762         int authmethod ));
 763
 764 LDAP_F( int )
 765 ldap_bind_s LDAP_P((    /* deprecated */
 766         LDAP *ld,
 767         LDAP_CONST char *who,
 768         LDAP_CONST char *cred,
 769         int authmethod ));
 770
 771 /*
 772  * in sbind.c:
 773  */
 774 LDAP_F( int )
 775 ldap_simple_bind LDAP_P((
 776         LDAP *ld,
 777         LDAP_CONST char *who,
 778         LDAP_CONST char *passwd ));
 779
 780 LDAP_F( int )
 781 ldap_simple_bind_s LDAP_P((
 782         LDAP *ld,
 783         LDAP_CONST char *who,
 784         LDAP_CONST char *passwd ));
 785
 786
 787 /*
 788  * in kbind.c:
 789  *      (deprecated)
 790  */
 791 LDAP_F( int )
 792 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 793         LDAP *ld,
 794         LDAP_CONST char *who ));
 795
 796 LDAP_F( int )
 797 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 798         LDAP *ld,
 799         LDAP_CONST char *who ));
 800
 801 LDAP_F( int )
 802 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 803         LDAP *ld,
 804         LDAP_CONST char *who ));
 805
 806 LDAP_F( int )
 807 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 808         LDAP *ld,
 809         LDAP_CONST char *who ));
 810
 811 LDAP_F( int )
 812 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 813         LDAP *ld,
 814         LDAP_CONST char *who ));
 815
 816 /*
 817  * in cache.c
 818  * (deprecated)
 819  */
 820 LDAP_F( int )
 821 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 822
 823 LDAP_F( void )
 824 ldap_disable_cache LDAP_P(( LDAP *ld ));
 825
 826 LDAP_F( void )
 827 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 828
 829 LDAP_F( void )
 830 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 831
 832 LDAP_F( void )
 833 ldap_flush_cache LDAP_P(( LDAP *ld ));
 834
 835 LDAP_F( void )
 836 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 837
 838 LDAP_F( void )
 839 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 840
 841
 842 /*
 843  * in compare.c:
 844  */
 845 LDAP_F( int )
 846 ldap_compare_ext LDAP_P((
 847         LDAP                    *ld,
 848         LDAP_CONST char *dn,
 849         LDAP_CONST char *attr,
 850         struct berval   *bvalue,
 851         LDAPControl             **serverctrls,
 852         LDAPControl             **clientctrls,
 853         int                     *msgidp ));
 854
 855 LDAP_F( int )
 856 ldap_compare_ext_s LDAP_P((
 857         LDAP                    *ld,
 858         LDAP_CONST char *dn,
 859         LDAP_CONST char *attr,
 860         struct berval   *bvalue,
 861         LDAPControl             **serverctrls,
 862         LDAPControl             **clientctrls ));
 863
 864 LDAP_F( int )
 865 ldap_compare LDAP_P((   /* deprecated */
 866         LDAP *ld,
 867         LDAP_CONST char *dn,
 868         LDAP_CONST char *attr,
 869         LDAP_CONST char *value ));
 870
 871 LDAP_F( int )
 872 ldap_compare_s LDAP_P(( /* deprecated */
 873         LDAP *ld,
 874         LDAP_CONST char *dn,
 875         LDAP_CONST char *attr,
 876         LDAP_CONST char *value ));
 877
 878
 879 /*
 880  * in delete.c:
 881  */
 882 LDAP_F( int )
 883 ldap_delete_ext LDAP_P((
 884         LDAP                    *ld,
 885         LDAP_CONST char *dn,
 886         LDAPControl             **serverctrls,
 887         LDAPControl             **clientctrls,
 888         int                     *msgidp ));
 889
 890 LDAP_F( int )
 891 ldap_delete_ext_s LDAP_P((
 892         LDAP                    *ld,
 893         LDAP_CONST char *dn,
 894         LDAPControl             **serverctrls,
 895         LDAPControl             **clientctrls ));
 896
 897 LDAP_F( int )
 898 ldap_delete LDAP_P((    /* deprecated */
 899         LDAP *ld,
 900         LDAP_CONST char *dn ));
 901
 902 LDAP_F( int )
 903 ldap_delete_s LDAP_P((  /* deprecated */
 904         LDAP *ld,
 905         LDAP_CONST char *dn ));
 906
 907
 908 /*
 909  * in error.c:
 910  */
 911 LDAP_F( int )
 912 ldap_parse_result LDAP_P((
 913         LDAP                    *ld,
 914         LDAPMessage             *res,
 915         int                             *errcodep,
 916         char                    **matcheddnp,
 917         char                    **errmsgp,
 918         char                    ***referralsp,
 919         LDAPControl             ***serverctrls,
 920         int                             freeit ));
 921
 922 LDAP_F( char *)
 923 ldap_err2string LDAP_P((
 924         int err ));
 925
 926 LDAP_F( int )
 927 ldap_result2error LDAP_P((      /* deprecated */
 928         LDAP *ld,
 929         LDAPMessage *r,
 930         int freeit ));
 931
 932 LDAP_F( void )
 933 ldap_perror LDAP_P((    /* deprecated */
 934         LDAP *ld,
 935         LDAP_CONST char *s ));
 936
 937
 938 /*
 939  * in modify.c:
 940  */
 941 LDAP_F( int )
 942 ldap_modify_ext LDAP_P((
 943         LDAP                    *ld,
 944         LDAP_CONST char *dn,
 945         LDAPMod                 **mods,
 946         LDAPControl             **serverctrls,
 947         LDAPControl             **clientctrls,
 948         int                     *msgidp ));
 949
 950 LDAP_F( int )
 951 ldap_modify_ext_s LDAP_P((
 952         LDAP                    *ld,
 953         LDAP_CONST char *dn,
 954         LDAPMod                 **mods,
 955         LDAPControl             **serverctrls,
 956         LDAPControl             **clientctrls ));
 957
 958 LDAP_F( int )
 959 ldap_modify LDAP_P((    /* deprecated */
 960         LDAP *ld,
 961         LDAP_CONST char *dn,
 962         LDAPMod **mods ));
 963
 964 LDAP_F( int )
 965 ldap_modify_s LDAP_P((  /* deprecated */
 966         LDAP *ld,
 967         LDAP_CONST char *dn,
 968         LDAPMod **mods ));
 969
 970
 971 /*
 972  * in modrdn.c:
 973  */
 974 LDAP_F( int )
 975 ldap_rename LDAP_P((
 976         LDAP *ld,
 977         LDAP_CONST char *dn,
 978         LDAP_CONST char *newrdn,
 979         LDAP_CONST char *newSuperior,
 980         int deleteoldrdn,
 981         LDAPControl **sctrls,
 982         LDAPControl **cctrls,
 983         int *msgidp ));
 984
 985 LDAP_F( int )
 986 ldap_rename_s LDAP_P((
 987         LDAP *ld,
 988         LDAP_CONST char *dn,
 989         LDAP_CONST char *newrdn,
 990         LDAP_CONST char *newSuperior,
 991         int deleteoldrdn,
 992         LDAPControl **sctrls,
 993         LDAPControl **cctrls ));
 994
 995 LDAP_F( int )
 996 ldap_rename2 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_rename2_s LDAP_P(( /* deprecated */
1005         LDAP *ld,
1006         LDAP_CONST char *dn,
1007         LDAP_CONST char *newrdn,
1008         LDAP_CONST char *newSuperior,
1009         int deleteoldrdn ));
1010
1011 LDAP_F( int )
1012 ldap_modrdn LDAP_P((    /* deprecated */
1013         LDAP *ld,
1014         LDAP_CONST char *dn,
1015         LDAP_CONST char *newrdn ));
1016
1017 LDAP_F( int )
1018 ldap_modrdn_s LDAP_P((  /* deprecated */
1019         LDAP *ld,
1020         LDAP_CONST char *dn,
1021         LDAP_CONST char *newrdn ));
1022
1023 LDAP_F( int )
1024 ldap_modrdn2 LDAP_P((   /* deprecated */
1025         LDAP *ld,
1026         LDAP_CONST char *dn,
1027         LDAP_CONST char *newrdn,
1028         int deleteoldrdn ));
1029
1030 LDAP_F( int )
1031 ldap_modrdn2_s LDAP_P(( /* deprecated */
1032         LDAP *ld,
1033         LDAP_CONST char *dn,
1034         LDAP_CONST char *newrdn,
1035         int deleteoldrdn));
1036
1037
1038 /*
1039  * in open.c:
1040  */
1041 LDAP_F( LDAP *)
1042 ldap_init LDAP_P((
1043         LDAP_CONST char *host,
1044         int port ));
1045
1046 LDAP_F( LDAP *)
1047 ldap_open LDAP_P((      /* deprecated */
1048         LDAP_CONST char *host,
1049         int port ));
1050
1051 LDAP_F( int )
1052 ldap_create LDAP_P((
1053         LDAP **ldp ));
1054
1055 LDAP_F( int )
1056 ldap_initialize LDAP_P((
1057         LDAP **ldp,
1058         LDAP_CONST char *url ));
1059
1060 LDAP_F( int )
1061 ldap_start_tls_s LDAP_P((
1062         LDAP *ld,
1063         LDAPControl **serverctrls,
1064         LDAPControl **clientctrls ));
1065
1066 /*
1067  * in messages.c:
1068  */
1069 LDAP_F( LDAPMessage *)
1070 ldap_first_message LDAP_P((
1071         LDAP *ld,
1072         LDAPMessage *chain ));
1073
1074 LDAP_F( LDAPMessage *)
1075 ldap_next_message LDAP_P((
1076         LDAP *ld,
1077         LDAPMessage *msg ));
1078
1079 LDAP_F( int )
1080 ldap_count_messages LDAP_P((
1081         LDAP *ld,
1082         LDAPMessage *chain ));
1083
1084
1085 /*
1086  * in references.c:
1087  */
1088 LDAP_F( LDAPMessage *)
1089 ldap_first_reference LDAP_P((
1090         LDAP *ld,
1091         LDAPMessage *chain ));
1092
1093 LDAP_F( LDAPMessage *)
1094 ldap_next_reference LDAP_P((
1095         LDAP *ld,
1096         LDAPMessage *ref ));
1097
1098 LDAP_F( int )
1099 ldap_count_references LDAP_P((
1100         LDAP *ld,
1101         LDAPMessage *chain ));
1102
1103 LDAP_F( int )
1104 ldap_parse_reference LDAP_P((
1105         LDAP                    *ld,
1106         LDAPMessage             *ref,
1107         char                    ***referralsp,
1108         LDAPControl             ***serverctrls,
1109         int                             freeit));
1110
1111
1112 /*
1113  * in getentry.c:
1114  */
1115 LDAP_F( LDAPMessage *)
1116 ldap_first_entry LDAP_P((
1117         LDAP *ld,
1118         LDAPMessage *chain ));
1119
1120 LDAP_F( LDAPMessage *)
1121 ldap_next_entry LDAP_P((
1122         LDAP *ld,
1123         LDAPMessage *entry ));
1124
1125 LDAP_F( int )
1126 ldap_count_entries LDAP_P((
1127         LDAP *ld,
1128         LDAPMessage *chain ));
1129
1130 LDAP_F( int )
1131 ldap_get_entry_controls LDAP_P((
1132         LDAP                    *ld,
1133         LDAPMessage             *entry,
1134         LDAPControl             ***serverctrls));
1135
1136
1137 /*
1138  * in addentry.c
1139  */
1140 LDAP_F( LDAPMessage *)
1141 ldap_delete_result_entry LDAP_P((
1142         LDAPMessage **list,
1143         LDAPMessage *e ));
1144
1145 LDAP_F( void )
1146 ldap_add_result_entry LDAP_P((
1147         LDAPMessage **list,
1148         LDAPMessage *e ));
1149
1150
1151 /*
1152  * in getdn.c
1153  */
1154 LDAP_F( char * )
1155 ldap_get_dn LDAP_P((
1156         LDAP *ld,
1157         LDAPMessage *entry ));
1158
1159 LDAP_F( char * )
1160 ldap_dn2ufn LDAP_P((
1161         LDAP_CONST char *dn ));
1162
1163 LDAP_F( char ** )
1164 ldap_explode_dn LDAP_P((
1165         LDAP_CONST char *dn,
1166         int notypes ));
1167
1168 LDAP_F( char ** )
1169 ldap_explode_rdn LDAP_P((
1170         LDAP_CONST char *rdn,
1171         int notypes ));
1172
1173 LDAP_F( char * )
1174 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1175
1176 LDAP_F( char * )
1177 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1178
1179 /*
1180  * in getattr.c
1181  */
1182 LDAP_F( char *)
1183 ldap_first_attribute LDAP_P((
1184         LDAP *ld,
1185         LDAPMessage *entry,
1186         BerElement **ber ));
1187
1188 LDAP_F( char *)
1189 ldap_next_attribute LDAP_P((
1190         LDAP *ld,
1191         LDAPMessage *entry,
1192         BerElement *ber ));
1193
1194
1195 /*
1196  * in getvalues.c
1197  */
1198 LDAP_F( char **)
1199 ldap_get_values LDAP_P((
1200         LDAP *ld,
1201         LDAPMessage *entry,
1202         LDAP_CONST char *target ));
1203
1204 LDAP_F( struct berval **)
1205 ldap_get_values_len LDAP_P((
1206         LDAP *ld,
1207         LDAPMessage *entry,
1208         LDAP_CONST char *target ));
1209
1210 LDAP_F( int )
1211 ldap_count_values LDAP_P((
1212         char **vals ));
1213
1214 LDAP_F( int )
1215 ldap_count_values_len LDAP_P((
1216         struct berval **vals ));
1217
1218 LDAP_F( void )
1219 ldap_value_free LDAP_P((
1220         char **vals ));
1221
1222 LDAP_F( void )
1223 ldap_value_free_len LDAP_P((
1224         struct berval **vals ));
1225
1226 /*
1227  * in result.c:
1228  */
1229 LDAP_F( int )
1230 ldap_result LDAP_P((
1231         LDAP *ld,
1232         int msgid,
1233         int all,
1234         struct timeval *timeout,
1235         LDAPMessage **result ));
1236
1237 LDAP_F( int )
1238 ldap_msgtype LDAP_P((
1239         LDAPMessage *lm ));
1240
1241 LDAP_F( int )
1242 ldap_msgid   LDAP_P((
1243         LDAPMessage *lm ));
1244
1245 LDAP_F( int )
1246 ldap_msgfree LDAP_P((
1247         LDAPMessage *lm ));
1248
1249 LDAP_F( int )
1250 ldap_msgdelete LDAP_P((
1251         LDAP *ld,
1252         int msgid ));
1253
1254
1255 /*
1256  * in search.c:
1257  */
1258 LDAP_F( int )
1259 ldap_search_ext LDAP_P((
1260         LDAP                    *ld,
1261         LDAP_CONST char *base,
1262         int                             scope,
1263         LDAP_CONST char *filter,
1264         char                    **attrs,
1265         int                             attrsonly,
1266         LDAPControl             **serverctrls,
1267         LDAPControl             **clientctrls,
1268         struct timeval  *timeout,
1269         int                             sizelimit,
1270         int                             *msgidp ));
1271
1272 LDAP_F( int )
1273 ldap_search_ext_s LDAP_P((
1274         LDAP                    *ld,
1275         LDAP_CONST char *base,
1276         int                             scope,
1277         LDAP_CONST char *filter,
1278         char                    **attrs,
1279         int                             attrsonly,
1280         LDAPControl             **serverctrls,
1281         LDAPControl             **clientctrls,
1282         struct timeval  *timeout,
1283         int                             sizelimit,
1284         LDAPMessage             **res ));
1285
1286 LDAP_F( int )
1287 ldap_search LDAP_P((    /* deprecated */
1288         LDAP *ld,
1289         LDAP_CONST char *base,
1290         int scope,
1291         LDAP_CONST char *filter,
1292         char **attrs,
1293         int attrsonly ));
1294
1295 LDAP_F( int )
1296 ldap_search_s LDAP_P((  /* deprecated */
1297         LDAP *ld,
1298         LDAP_CONST char *base,
1299         int scope,
1300         LDAP_CONST char *filter,
1301         char **attrs,
1302         int attrsonly,
1303         LDAPMessage **res ));
1304
1305 LDAP_F( int )
1306 ldap_search_st LDAP_P(( /* deprecated */
1307         LDAP *ld,
1308         LDAP_CONST char *base,
1309         int scope,
1310         LDAP_CONST char *filter,
1311     char **attrs,
1312         int attrsonly,
1313         struct timeval *timeout,
1314         LDAPMessage **res ));
1315
1316
1317 /*
1318  * in ufn.c
1319  *      (deprecated)
1320  */
1321 LDAP_F( int )
1322 ldap_ufn_search_c LDAP_P(( /* deprecated */
1323         LDAP *ld,
1324         LDAP_CONST char *ufn,
1325         char **attrs,
1326         int attrsonly,
1327         LDAPMessage **res,
1328         int (*cancelproc)( void *cl ),
1329         void *cancelparm ));
1330
1331 LDAP_F( int )
1332 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1333         LDAP *ld,
1334         LDAP_CONST char *ufn,
1335         char **attrs,
1336         int attrsonly,
1337         LDAPMessage **res,
1338         int (*cancelproc)( void *cl ),
1339         void *cancelparm,
1340         char *tag1,
1341         char *tag2,
1342         char *tag3 ));
1343
1344 LDAP_F( int )
1345 ldap_ufn_search_s LDAP_P(( /* deprecated */
1346         LDAP *ld,
1347         LDAP_CONST char *ufn,
1348         char **attrs,
1349         int attrsonly,
1350         LDAPMessage **res ));
1351
1352 LDAP_F( LDAPFiltDesc *)
1353 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1354         LDAP *ld,
1355         LDAP_CONST char *fname ));
1356
1357 LDAP_F( void )
1358 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1359         LDAP *ld,
1360         LDAP_CONST char *prefix ));
1361
1362 LDAP_F( int )
1363 ldap_ufn_timeout LDAP_P(( /* deprecated */
1364         void *tvparam ));
1365
1366
1367 /*
1368  * in unbind.c
1369  */
1370 LDAP_F( int )
1371 ldap_unbind LDAP_P(( /* deprecated */
1372         LDAP *ld ));
1373
1374 LDAP_F( int )
1375 ldap_unbind_s LDAP_P(( /* deprecated */
1376         LDAP *ld ));
1377
1378 LDAP_F( int )
1379 ldap_unbind_ext LDAP_P((
1380         LDAP                    *ld,
1381         LDAPControl             **serverctrls,
1382         LDAPControl             **clientctrls));
1383
1384 LDAP_F( int )
1385 ldap_unbind_ext_s LDAP_P((
1386         LDAP                    *ld,
1387         LDAPControl             **serverctrls,
1388         LDAPControl             **clientctrls));
1389
1390 /*
1391  * in getfilter.c
1392  *      (deprecated)
1393  */
1394 LDAP_F( LDAPFiltDesc *)
1395 ldap_init_getfilter LDAP_P(( /* deprecated */
1396         LDAP_CONST char *fname ));
1397
1398 LDAP_F( LDAPFiltDesc *)
1399 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1400         /* LDAP_CONST */ char *buf,
1401         ber_len_t buflen ));
1402
1403 LDAP_F( LDAPFiltInfo *)
1404 ldap_getfirstfilter LDAP_P(( /* deprecated */
1405         LDAPFiltDesc *lfdp,
1406         /* LDAP_CONST */ char *tagpat,
1407         /* LDAP_CONST */ char *value ));
1408
1409 LDAP_F( LDAPFiltInfo *)
1410 ldap_getnextfilter LDAP_P(( /* deprecated */
1411         LDAPFiltDesc *lfdp ));
1412
1413 LDAP_F( void )
1414 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1415         LDAPFiltDesc *lfdp,
1416         LDAP_CONST char *prefix,
1417         LDAP_CONST char *suffix ));
1418
1419 LDAP_F( void )
1420 ldap_build_filter LDAP_P(( /* deprecated */
1421         char *buf,
1422         ber_len_t buflen,
1423         LDAP_CONST char *pattern,
1424         LDAP_CONST char *prefix,
1425         LDAP_CONST char *suffix,
1426         LDAP_CONST char *attr,
1427         LDAP_CONST char *value,
1428         char **valwords ));
1429
1430
1431 /*
1432  * in free.c
1433  */
1434
1435 LDAP_F( void * )
1436 ldap_memalloc LDAP_P((
1437         ber_len_t s ));
1438
1439 LDAP_F( void * )
1440 ldap_memrealloc LDAP_P((
1441         void* p,
1442         ber_len_t s ));
1443
1444 LDAP_F( void * )
1445 ldap_memcalloc LDAP_P((
1446         ber_len_t n,
1447         ber_len_t s ));
1448
1449 LDAP_F( void )
1450 ldap_memfree LDAP_P((
1451         void* p ));
1452
1453 LDAP_F( void )
1454 ldap_memvfree LDAP_P((
1455         void** v ));
1456
1457 LDAP_F( char * )
1458 ldap_strdup LDAP_P((
1459         LDAP_CONST char * ));
1460
1461 LDAP_F( void )
1462 ldap_getfilter_free LDAP_P((
1463         LDAPFiltDesc *lfdp ));
1464
1465 LDAP_F( void )
1466 ldap_mods_free LDAP_P((
1467         LDAPMod **mods,
1468         int freemods ));
1469
1470
1471 /*
1472  * in friendly.c
1473  *      (deprecated)
1474  */
1475 LDAP_F( char * )
1476 ldap_friendly_name LDAP_P(( /* deprecated */
1477         LDAP_CONST char *filename,
1478         /* LDAP_CONST */ char *uname,
1479         LDAPFriendlyMap **map ));
1480
1481 LDAP_F( void )
1482 ldap_free_friendlymap LDAP_P(( /* deprecated */
1483         LDAPFriendlyMap **map ));
1484
1485
1486 /*
1487  * in sort.c
1488  */
1489 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1490         LDAP_CONST char *left,
1491         LDAP_CONST char *right ));
1492
1493 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1494         LDAP_CONST void *left,
1495         LDAP_CONST void *right ));
1496
1497 LDAP_F( int )
1498 ldap_sort_entries LDAP_P(( LDAP *ld,
1499         LDAPMessage **chain,
1500         LDAP_CONST char *attr,
1501         LDAP_SORT_AD_CMP_PROC *cmp ));
1502
1503 LDAP_F( int )   /* deprecated */
1504 ldap_sort_values LDAP_P((
1505         LDAP *ld,
1506         char **vals,
1507         LDAP_SORT_AV_CMP_PROC *cmp ));
1508
1509 LDAP_F( int ) /* deprecated */
1510 ldap_sort_strcasecmp LDAP_P((
1511         LDAP_CONST void *a,
1512         LDAP_CONST void *b ));
1513
1514
1515 /*
1516  * in url.c
1517  *
1518  * need _ext varients
1519  */
1520 LDAP_F( int )
1521 ldap_is_ldap_url LDAP_P((
1522         LDAP_CONST char *url ));
1523
1524 LDAP_F( int )
1525 ldap_is_ldaps_url LDAP_P((
1526         LDAP_CONST char *url ));
1527
1528 LDAP_F( int )
1529 ldap_is_ldapi_url LDAP_P((
1530         LDAP_CONST char *url ));
1531
1532 LDAP_F( int )
1533 ldap_url_parse LDAP_P((
1534         LDAP_CONST char *url,
1535         LDAPURLDesc **ludpp ));
1536
1537 LDAP_F( void )
1538 ldap_free_urldesc LDAP_P((
1539         LDAPURLDesc *ludp ));
1540
1541 LDAP_F( int )
1542 ldap_url_search LDAP_P((
1543         LDAP *ld,
1544         LDAP_CONST char *url,
1545         int attrsonly ));
1546
1547 LDAP_F( int )
1548 ldap_url_search_s LDAP_P((
1549         LDAP *ld,
1550         LDAP_CONST char *url,
1551         int attrsonly,
1552         LDAPMessage **res ));
1553
1554 LDAP_F( int )
1555 ldap_url_search_st LDAP_P((
1556         LDAP *ld,
1557         LDAP_CONST char *url,
1558         int attrsonly,
1559         struct timeval *timeout,
1560         LDAPMessage **res ));
1561
1562 /*
1563  * in sortctrl.c
1564  */
1565 /*
1566  * structure for a sort-key
1567  */
1568 typedef struct ldapsortkey {
1569         char *  attributeType;
1570         char *  orderingRule;
1571         int     reverseOrder;
1572 } LDAPSortKey;
1573
1574 LDAP_F( int )
1575 ldap_create_sort_keylist LDAP_P((
1576         LDAPSortKey ***sortKeyList,
1577         char        *keyString ));
1578
1579 LDAP_F( void )
1580 ldap_free_sort_keylist LDAP_P((
1581         LDAPSortKey **sortkeylist ));
1582
1583 LDAP_F( int )
1584 ldap_create_sort_control LDAP_P((
1585         LDAP *ld,
1586         LDAPSortKey **keyList,
1587         int ctl_iscritical,
1588         LDAPControl **ctrlp ));
1589
1590 LDAP_F( int )
1591 ldap_parse_sort_control LDAP_P((
1592         LDAP           *ld,
1593         LDAPControl    **ctrlp,
1594         unsigned long  *result,
1595         char           **attribute ));
1596
1597
1598 /*
1599  * in vlvctrl.c
1600  */
1601
1602 /*
1603  * structure for virtul list.
1604  */
1605 typedef struct ldapvlvinfo {
1606         int             ldvlv_version;
1607     unsigned long   ldvlv_before_count;
1608     unsigned long   ldvlv_after_count;
1609     unsigned long   ldvlv_offset;
1610     unsigned long   ldvlv_count;
1611     struct berval  *ldvlv_attrvalue;
1612     struct berval  *ldvlv_context;
1613     void           *ldvlv_extradata;
1614 } LDAPVLVInfo;
1615
1616 LDAP_F( int )
1617 ldap_create_vlv_control LDAP_P((
1618         LDAP *ld,
1619         LDAPVLVInfo *ldvlistp,
1620         LDAPControl **ctrlp ));
1621
1622 LDAP_F( int )
1623 ldap_parse_vlv_control LDAP_P((
1624         LDAP          *ld,
1625         LDAPControl   **ctrls,
1626         unsigned long *target_posp,
1627         unsigned long *list_countp,
1628         struct berval **contextp,
1629         int           *errcodep ));
1630
1631
1632 LDAP_END_DECL
1633 #endif /* _LDAP_H */