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