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

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