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