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

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