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