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