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