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