git.sur5r.net Git - openldap/blob - include/ldap.h

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