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