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