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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2001 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /* Portions
  13  * Copyright (c) 1990 Regents of the University of Michigan.
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms are permitted
  17  * provided that this notice is preserved and that due credit is given
  18  * to the University of Michigan at Ann Arbor. The name of the University
  19  * may not be used to endorse or promote products derived from this
  20  * software without specific prior written permission. This software
  21  * is provided ``as is'' without express or implied warranty.
  22  */
  23
  24 #ifndef _LDAP_H
  25 #define _LDAP_H
  26
  27 /* pull in lber */
  28 #include <lber.h>
  29
  30 /* include version and API feature defines */
  31 #include <ldap_features.h>
  32
  33 LDAP_BEGIN_DECL
  34
  35 #define LDAP_VERSION1   1
  36 #define LDAP_VERSION2   2
  37 #define LDAP_VERSION3   3
  38
  39 #define LDAP_VERSION_MIN        LDAP_VERSION2
  40 #define LDAP_VERSION            LDAP_VERSION2
  41 #define LDAP_VERSION_MAX        LDAP_VERSION3
  42
  43 /*
  44  * We'll use 2000+draft revision for our API version number
  45  * As such, the number will be above the old RFC but below
  46  * whatever number does finally get assigned
  47  */
  48 #define LDAP_API_VERSION        2004
  49 #define LDAP_VENDOR_NAME        "OpenLDAP"
  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                          0x6000
 116 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 117 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 118 #define LDAP_OPT_X_TLS_CACERTDIR        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_PROTOCOL              0x6007 */
 123 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 124 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 125
 126 #define LDAP_OPT_X_TLS_NEVER            0
 127 #define LDAP_OPT_X_TLS_HARD             1
 128 #define LDAP_OPT_X_TLS_DEMAND           2
 129 #define LDAP_OPT_X_TLS_ALLOW            3
 130 #define LDAP_OPT_X_TLS_TRY              4
 131
 132 /* 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
 183 #ifdef undef
 184         /* chase referrals client control (not yet implemented)  */
 185 #define LDAP_CONTROL_REFERRALS  "1.2.840.113666.1.4.616"
 186 #define LDAP_CHASE_SUBORDINATE_REFERRALS        0x0020U
 187 #define LDAP_CHASE_EXTERNAL_REFERRALS   0x0040U
 188 #endif
 189
 190 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
 191
 192 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 193 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 194 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 195 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 196
 197 /* Experimental Controls */
 198
 199 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 200 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 201 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 202 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 203
 204 /* LDAP Unsolicited Notifications */
 205 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 206 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 207
 208 /* LDAP Extended Operations */
 209 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
 210
 211 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
 212 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID        ((ber_tag_t) 0x80U)
 213 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD       ((ber_tag_t) 0x81U)
 214 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW       ((ber_tag_t) 0x82U)
 215 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN       ((ber_tag_t) 0x80U)
 216
 217 /*
 218  * specific LDAP instantiations of BER types we know about
 219  */
 220
 221 /* Overview of LBER tag construction
 222  *
 223  *      Bits
 224  *      ______
 225  *      8 7 | CLASS
 226  *      0 0 = UNIVERSAL
 227  *      0 1 = APPLICATION
 228  *      1 0 = CONTEXT-SPECIFIC
 229  *      1 1 = PRIVATE
 230  *              _____
 231  *              | 6 | DATA-TYPE
 232  *                0 = PRIMITIVE
 233  *                1 = CONSTRUCTED
 234  *                      ___________
 235  *                      | 5 ... 1 | TAG-NUMBER
 236  */
 237
 238 /* general stuff */
 239 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 240 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 241 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 242 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 243 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 244 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 245
 246 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 247
 248 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 249 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 250 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 251 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 252
 253 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 254
 255
 256 /* possible operations a client can invoke */
 257 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
 258 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
 259 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
 260 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
 261 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
 262 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
 263 #define LDAP_REQ_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
 264 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
 265 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
 266 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
 267 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
 268 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
 269
 270 /* possible result types a server can return */
 271 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
 272 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
 273 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 274 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
 275 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
 276 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
 277 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
 278 #define LDAP_RES_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
 279 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
 280 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* application + constructed */
 281 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
 282 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 283 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
 284
 285 #define LDAP_RES_ANY                    (-1)
 286 #define LDAP_RES_UNSOLICITED    (0)
 287
 288
 289 /* sasl methods */
 290 #define LDAP_SASL_SIMPLE                ((char*)0)
 291 #define LDAP_SASL_NULL                  ("")
 292
 293
 294 /* authentication methods available */
 295 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
 296 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
 297 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 298 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
 299 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
 300 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
 301
 302
 303 /* filter types */
 304 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 305 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 306 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 307 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 308 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 309 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 310 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 311 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 312 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 313 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 314
 315 /* extended filter component types */
 316 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
 317 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 318 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 319 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 320
 321 /* substring filter component types */
 322 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 323 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 324 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 325
 326 /* search scopes */
 327 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
 328 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 329 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 330 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 331
 332 /* substring filter component types */
 333 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 334 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 335 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 336
 337 /*
 338  * possible error codes we can return
 339  */
 340
 341 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 342
 343 #define LDAP_SUCCESS                    0x00
 344 #define LDAP_OPERATIONS_ERROR           0x01
 345 #define LDAP_PROTOCOL_ERROR             0x02
 346 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 347 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 348 #define LDAP_COMPARE_FALSE              0x05
 349 #define LDAP_COMPARE_TRUE               0x06
 350 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 351 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 352 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 353 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 354
 355 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 356 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 357 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 358 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 359 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 360
 361 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 362
 363 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 364 #define LDAP_UNDEFINED_TYPE             0x11
 365 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 366 #define LDAP_CONSTRAINT_VIOLATION       0x13
 367 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 368 #define LDAP_INVALID_SYNTAX             0x15
 369
 370 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 371
 372 #define LDAP_NO_SUCH_OBJECT             0x20
 373 #define LDAP_ALIAS_PROBLEM              0x21
 374 #define LDAP_INVALID_DN_SYNTAX          0x22
 375 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 376 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 377
 378 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
 379
 380 #define LDAP_INAPPROPRIATE_AUTH         0x30
 381 #define LDAP_INVALID_CREDENTIALS        0x31
 382 #define LDAP_INSUFFICIENT_ACCESS        0x32
 383
 384 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 385
 386 #define LDAP_BUSY                       0x33
 387 #define LDAP_UNAVAILABLE                0x34
 388 #define LDAP_UNWILLING_TO_PERFORM       0x35
 389 #define LDAP_LOOP_DETECT                0x36
 390
 391 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 392
 393 #define LDAP_NAMING_VIOLATION           0x40
 394 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 395 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 396 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 397 #define LDAP_ALREADY_EXISTS             0x44
 398 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 399 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 400 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 401
 402 #define LDAP_OTHER                      0x50
 403
 404 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 405 #define LDAP_API_RESULT(n)              (((n) == LDAP_SUCCESS) || \
 406                                                                         LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
 407
 408 /* reserved for APIs */
 409 #define LDAP_SERVER_DOWN                0x51
 410 #define LDAP_LOCAL_ERROR                0x52
 411 #define LDAP_ENCODING_ERROR             0x53
 412 #define LDAP_DECODING_ERROR             0x54
 413 #define LDAP_TIMEOUT                    0x55
 414 #define LDAP_AUTH_UNKNOWN               0x56
 415 #define LDAP_FILTER_ERROR               0x57
 416 #define LDAP_USER_CANCELLED             0x58
 417 #define LDAP_PARAM_ERROR                0x59
 418 #define LDAP_NO_MEMORY                  0x5a
 419
 420 /* used but not reserved for APIs */
 421 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 422 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 423 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 424 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 425 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 426 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 427 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 428
 429 /*
 430  * This structure represents both ldap messages and ldap responses.
 431  * These are really the same, except in the case of search responses,
 432  * where a response has multiple messages.
 433  */
 434
 435 typedef struct ldapmsg LDAPMessage;
 436
 437 /* for modifications */
 438 typedef struct ldapmod {
 439         int             mod_op;
 440
 441 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 442 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 443 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 444 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 445 /* IMPORTANT: do not use code 0x1000 (or above),
 446  * it is used internally by the backends!
 447  * (see ldap/servers/slapd/slap.h)
 448  */
 449
 450         char            *mod_type;
 451         union mod_vals_u {
 452                 char            **modv_strvals;
 453                 struct berval   **modv_bvals;
 454         } mod_vals;
 455 #define mod_values      mod_vals.modv_strvals
 456 #define mod_bvalues     mod_vals.modv_bvals
 457 } LDAPMod;
 458
 459 /*
 460  * structures for ldap getfilter routines
 461  */
 462
 463 typedef struct ldap_filt_info {
 464         char                    *lfi_filter;
 465         char                    *lfi_desc;
 466         int                     lfi_scope;
 467         int                     lfi_isexact;
 468         struct ldap_filt_info   *lfi_next;
 469 } LDAPFiltInfo;
 470
 471 typedef struct ldap_filt_list {
 472     char                        *lfl_tag;
 473     char                        *lfl_pattern;
 474     char                        *lfl_delims;
 475     LDAPFiltInfo                *lfl_ilist;
 476     struct ldap_filt_list       *lfl_next;
 477 } LDAPFiltList;
 478
 479
 480 #define LDAP_FILT_MAXSIZ        1024
 481
 482 typedef struct ldap_filt_desc {
 483         LDAPFiltList            *lfd_filtlist;
 484         LDAPFiltInfo            *lfd_curfip;
 485         LDAPFiltInfo            lfd_retfi;
 486         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 487         char                    *lfd_curval;
 488         char                    *lfd_curvalcopy;
 489         char                    **lfd_curvalwords;
 490         char                    *lfd_filtprefix;
 491         char                    *lfd_filtsuffix;
 492 } LDAPFiltDesc;
 493
 494
 495 /*
 496  * structure representing an ldap session which can
 497  * encompass connections to multiple servers (in the
 498  * face of referrals).
 499  */
 500 typedef struct ldap LDAP;
 501
 502 #define LDAP_DEREF_NEVER        0x00
 503 #define LDAP_DEREF_SEARCHING    0x01
 504 #define LDAP_DEREF_FINDING      0x02
 505 #define LDAP_DEREF_ALWAYS       0x03
 506
 507 #define LDAP_NO_LIMIT           0
 508
 509 /* how many messages to retrieve results for */
 510 #define LDAP_MSG_ONE            0x00
 511 #define LDAP_MSG_ALL            0x01
 512 #define LDAP_MSG_RECEIVED       0x02
 513
 514 /*
 515  * types for ldap URL handling
 516  */
 517 typedef struct ldap_url_desc {
 518         struct ldap_url_desc *lud_next;
 519         char    *lud_scheme;
 520         char    *lud_host;
 521         int             lud_port;
 522         char    *lud_dn;
 523         char    **lud_attrs;
 524         int             lud_scope;
 525         char    *lud_filter;
 526         char    **lud_exts;
 527         int             lud_crit_exts;
 528 } LDAPURLDesc;
 529
 530 #define LDAP_URL_SUCCESS                0x00    /* Success */
 531 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 532 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 533
 534 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 535 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 536 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 537 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 538 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 539 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 540 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 541 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 542
 543 /*
 544  * The API draft spec says we should declare (or cause to be declared)
 545  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 546  */
 547 struct timeval;
 548
 549 /*
 550  * in options.c:
 551  */
 552 LDAP_F( int )
 553 ldap_get_option LDAP_P((
 554         LDAP *ld,
 555         int option,
 556         void *outvalue));
 557
 558 LDAP_F( int )
 559 ldap_set_option LDAP_P((
 560         LDAP *ld,
 561         int option,
 562         LDAP_CONST void *invalue));
 563
 564 /* V3 REBIND Function Callback Prototype */
 565 typedef int (LDAP_REBIND_PROC) LDAP_P((
 566         LDAP *ld, LDAP_CONST char *url,
 567         ber_tag_t request, ber_int_t msgid,
 568         void *params ));
 569
 570 LDAP_F( int )
 571 ldap_set_rebind_proc LDAP_P((
 572         LDAP *ld,
 573         LDAP_REBIND_PROC *rebind_proc,
 574         void *params ));
 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 typedef struct ldap_ava {
1167         struct berval *la_attr;
1168         struct berval *la_value;
1169         unsigned la_flags;
1170 #define LDAP_AVA_STRING         0x0000U
1171 #define LDAP_AVA_BINARY         0x0001U
1172 #define LDAP_AVA_NONPRINTABLE   0x0002U
1173
1174         void *la_private;
1175 } LDAPAVA;
1176
1177 typedef LDAPAVA** LDAPRDN;
1178 typedef LDAPRDN** LDAPDN;
1179
1180 /* DN formats */
1181 #define LDAP_DN_FORMAT_LDAP             0x0000U
1182 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1183 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1184 #define LDAP_DN_FORMAT_DCE              0x0030U
1185 #define LDAP_DN_FORMAT_UFN              0x0040U /* dn2str only */
1186 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1187 #define LDAP_DN_FORMAT_MASK             0x00F0U
1188
1189 /* DN flags */
1190 #define LDAP_DN_PRETTY                  0x0100U
1191 #define LDAP_DN_SKIP                    0x0200U
1192 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1193 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1194 #define LDAP_DN_PEDANTIC                0xF000U
1195
1196 LDAP_F( void )
1197 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1198 LDAP_F( void )
1199 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1200 LDAP_F( void )
1201 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1202
1203 LDAP_F( int )
1204 ldap_str2dn LDAP_P((
1205         LDAP_CONST char *str,
1206         LDAPDN **dn,
1207         unsigned flags ));
1208
1209 LDAP_F( int )
1210 ldap_dn2bv LDAP_P((
1211         LDAPDN *dn,
1212         struct berval *bv,
1213         unsigned flags ));
1214
1215 LDAP_F( int )
1216 ldap_dn2str LDAP_P((
1217         LDAPDN *dn,
1218         char **str,
1219         unsigned flags ));
1220
1221 LDAP_F( int )
1222 ldap_str2rdn LDAP_P((
1223         const char *str,
1224         LDAPRDN **rdn,
1225         const char **next,
1226         unsigned flags ));
1227
1228 LDAP_F( int )
1229 ldap_rdn2bv LDAP_P((
1230         LDAPRDN *rdn,
1231         struct berval *bv,
1232         unsigned flags ));
1233
1234 LDAP_F( int )
1235 ldap_rdn2str LDAP_P((
1236         LDAPRDN *rdn,
1237         char **str,
1238         unsigned flags ));
1239
1240 LDAP_F( int )
1241 ldap_dn_normalize LDAP_P((
1242         LDAP_CONST char *in, unsigned iflags,
1243         char **out, unsigned oflags ));
1244
1245 LDAP_F( char * )
1246 ldap_dn2ufn LDAP_P(( /* deprecated */
1247         LDAP_CONST char *dn ));
1248
1249 LDAP_F( char ** )
1250 ldap_explode_dn LDAP_P(( /* deprecated */
1251         LDAP_CONST char *dn,
1252         int notypes ));
1253
1254 LDAP_F( char ** )
1255 ldap_explode_rdn LDAP_P(( /* deprecated */
1256         LDAP_CONST char *rdn,
1257         int notypes ));
1258
1259 LDAP_F( char * )
1260 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1261
1262 LDAP_F( char * )
1263 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1264
1265 LDAP_F( char * )
1266 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1267
1268 /*
1269  * in getattr.c
1270  */
1271 LDAP_F( char * )
1272 ldap_first_attribute LDAP_P((
1273         LDAP *ld,
1274         LDAPMessage *entry,
1275         BerElement **ber ));
1276
1277 LDAP_F( char * )
1278 ldap_next_attribute LDAP_P((
1279         LDAP *ld,
1280         LDAPMessage *entry,
1281         BerElement *ber ));
1282
1283
1284 /*
1285  * in getvalues.c
1286  */
1287 LDAP_F( struct berval ** )
1288 ldap_get_values_len LDAP_P((
1289         LDAP *ld,
1290         LDAPMessage *entry,
1291         LDAP_CONST char *target ));
1292
1293 LDAP_F( int )
1294 ldap_count_values_len LDAP_P((
1295         struct berval **vals ));
1296
1297 LDAP_F( void )
1298 ldap_value_free_len LDAP_P((
1299         struct berval **vals ));
1300
1301 LDAP_F( char ** )
1302 ldap_get_values LDAP_P((        /* deprecated */
1303         LDAP *ld,
1304         LDAPMessage *entry,
1305         LDAP_CONST char *target ));
1306
1307 LDAP_F( int )
1308 ldap_count_values LDAP_P((      /* deprecated */
1309         char **vals ));
1310
1311 LDAP_F( void )
1312 ldap_value_free LDAP_P((        /* deprecated */
1313         char **vals ));
1314
1315 /*
1316  * in result.c:
1317  */
1318 LDAP_F( int )
1319 ldap_result LDAP_P((
1320         LDAP *ld,
1321         int msgid,
1322         int all,
1323         struct timeval *timeout,
1324         LDAPMessage **result ));
1325
1326 LDAP_F( int )
1327 ldap_msgtype LDAP_P((
1328         LDAPMessage *lm ));
1329
1330 LDAP_F( int )
1331 ldap_msgid   LDAP_P((
1332         LDAPMessage *lm ));
1333
1334 LDAP_F( int )
1335 ldap_msgfree LDAP_P((
1336         LDAPMessage *lm ));
1337
1338 LDAP_F( int )
1339 ldap_msgdelete LDAP_P((
1340         LDAP *ld,
1341         int msgid ));
1342
1343
1344 /*
1345  * in search.c:
1346  */
1347 LDAP_F( int )
1348 ldap_search_ext LDAP_P((
1349         LDAP                    *ld,
1350         LDAP_CONST char *base,
1351         int                             scope,
1352         LDAP_CONST char *filter,
1353         char                    **attrs,
1354         int                             attrsonly,
1355         LDAPControl             **serverctrls,
1356         LDAPControl             **clientctrls,
1357         struct timeval  *timeout,
1358         int                             sizelimit,
1359         int                             *msgidp ));
1360
1361 LDAP_F( int )
1362 ldap_search_ext_s LDAP_P((
1363         LDAP                    *ld,
1364         LDAP_CONST char *base,
1365         int                             scope,
1366         LDAP_CONST char *filter,
1367         char                    **attrs,
1368         int                             attrsonly,
1369         LDAPControl             **serverctrls,
1370         LDAPControl             **clientctrls,
1371         struct timeval  *timeout,
1372         int                             sizelimit,
1373         LDAPMessage             **res ));
1374
1375 LDAP_F( int )
1376 ldap_search LDAP_P((    /* deprecated */
1377         LDAP *ld,
1378         LDAP_CONST char *base,
1379         int scope,
1380         LDAP_CONST char *filter,
1381         char **attrs,
1382         int attrsonly ));
1383
1384 LDAP_F( int )
1385 ldap_search_s LDAP_P((  /* deprecated */
1386         LDAP *ld,
1387         LDAP_CONST char *base,
1388         int scope,
1389         LDAP_CONST char *filter,
1390         char **attrs,
1391         int attrsonly,
1392         LDAPMessage **res ));
1393
1394 LDAP_F( int )
1395 ldap_search_st LDAP_P(( /* deprecated */
1396         LDAP *ld,
1397         LDAP_CONST char *base,
1398         int scope,
1399         LDAP_CONST char *filter,
1400     char **attrs,
1401         int attrsonly,
1402         struct timeval *timeout,
1403         LDAPMessage **res ));
1404
1405 /*
1406  * in unbind.c
1407  */
1408 LDAP_F( int )
1409 ldap_unbind LDAP_P(( /* deprecated */
1410         LDAP *ld ));
1411
1412 LDAP_F( int )
1413 ldap_unbind_s LDAP_P(( /* deprecated */
1414         LDAP *ld ));
1415
1416 LDAP_F( int )
1417 ldap_unbind_ext LDAP_P((
1418         LDAP                    *ld,
1419         LDAPControl             **serverctrls,
1420         LDAPControl             **clientctrls));
1421
1422 LDAP_F( int )
1423 ldap_unbind_ext_s LDAP_P((
1424         LDAP                    *ld,
1425         LDAPControl             **serverctrls,
1426         LDAPControl             **clientctrls));
1427
1428 /*
1429  * in getfilter.c
1430  *      (deprecated)
1431  */
1432 LDAP_F( LDAPFiltDesc * )
1433 ldap_init_getfilter LDAP_P(( /* deprecated */
1434         LDAP_CONST char *fname ));
1435
1436 LDAP_F( LDAPFiltInfo * )
1437 ldap_getfirstfilter LDAP_P(( /* deprecated */
1438         LDAPFiltDesc *lfdp,
1439         /* LDAP_CONST */ char *tagpat,
1440         /* LDAP_CONST */ char *value ));
1441
1442 LDAP_F( LDAPFiltInfo * )
1443 ldap_getnextfilter LDAP_P(( /* deprecated */
1444         LDAPFiltDesc *lfdp ));
1445
1446
1447 /*
1448  * in free.c
1449  */
1450
1451 LDAP_F( void * )
1452 ldap_memalloc LDAP_P((
1453         ber_len_t s ));
1454
1455 LDAP_F( void * )
1456 ldap_memrealloc LDAP_P((
1457         void* p,
1458         ber_len_t s ));
1459
1460 LDAP_F( void * )
1461 ldap_memcalloc LDAP_P((
1462         ber_len_t n,
1463         ber_len_t s ));
1464
1465 LDAP_F( void )
1466 ldap_memfree LDAP_P((
1467         void* p ));
1468
1469 LDAP_F( void )
1470 ldap_memvfree LDAP_P((
1471         void** v ));
1472
1473 LDAP_F( char * )
1474 ldap_strdup LDAP_P((
1475         LDAP_CONST char * ));
1476
1477 LDAP_F( void )
1478 ldap_getfilter_free LDAP_P((
1479         LDAPFiltDesc *lfdp ));
1480
1481 LDAP_F( void )
1482 ldap_mods_free LDAP_P((
1483         LDAPMod **mods,
1484         int freemods ));
1485
1486
1487 /*
1488  * in sort.c
1489  *      (deprecated)
1490  */
1491 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1492         LDAP_CONST char *left,
1493         LDAP_CONST char *right ));
1494
1495 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1496         LDAP_CONST void *left,
1497         LDAP_CONST void *right ));
1498
1499 LDAP_F( int )   /* deprecated */
1500 ldap_sort_entries LDAP_P(( LDAP *ld,
1501         LDAPMessage **chain,
1502         LDAP_CONST char *attr,
1503         LDAP_SORT_AD_CMP_PROC *cmp ));
1504
1505 LDAP_F( int )   /* deprecated */
1506 ldap_sort_values LDAP_P((
1507         LDAP *ld,
1508         char **vals,
1509         LDAP_SORT_AV_CMP_PROC *cmp ));
1510
1511 LDAP_F( int ) /* deprecated */
1512 ldap_sort_strcasecmp LDAP_P((
1513         LDAP_CONST void *a,
1514         LDAP_CONST void *b ));
1515
1516
1517 /*
1518  * in url.c
1519  */
1520 LDAP_F( int )
1521 ldap_is_ldap_url LDAP_P((
1522         LDAP_CONST char *url ));
1523
1524 LDAP_F( int )
1525 ldap_is_ldaps_url LDAP_P((
1526         LDAP_CONST char *url ));
1527
1528 LDAP_F( int )
1529 ldap_is_ldapi_url LDAP_P((
1530         LDAP_CONST char *url ));
1531
1532 LDAP_F( int )
1533 ldap_url_parse LDAP_P((
1534         LDAP_CONST char *url,
1535         LDAPURLDesc **ludpp ));
1536
1537 LDAP_F( char * )
1538 ldap_url_desc2str LDAP_P((
1539         LDAPURLDesc *ludp ));
1540
1541 LDAP_F( void )
1542 ldap_free_urldesc LDAP_P((
1543         LDAPURLDesc *ludp ));
1544
1545 /*
1546  * in sortctrl.c
1547  */
1548 /*
1549  * structure for a sort-key
1550  */
1551 typedef struct ldapsortkey {
1552         char *  attributeType;
1553         char *  orderingRule;
1554         int     reverseOrder;
1555 } LDAPSortKey;
1556
1557 LDAP_F( int )
1558 ldap_create_sort_keylist LDAP_P((
1559         LDAPSortKey ***sortKeyList,
1560         char        *keyString ));
1561
1562 LDAP_F( void )
1563 ldap_free_sort_keylist LDAP_P((
1564         LDAPSortKey **sortkeylist ));
1565
1566 LDAP_F( int )
1567 ldap_create_sort_control LDAP_P((
1568         LDAP *ld,
1569         LDAPSortKey **keyList,
1570         int ctl_iscritical,
1571         LDAPControl **ctrlp ));
1572
1573 LDAP_F( int )
1574 ldap_parse_sort_control LDAP_P((
1575         LDAP           *ld,
1576         LDAPControl    **ctrlp,
1577         unsigned long  *result,
1578         char           **attribute ));
1579
1580
1581 /*
1582  * in vlvctrl.c
1583  */
1584
1585 /*
1586  * structure for virtul list.
1587  */
1588 typedef struct ldapvlvinfo {
1589         int             ldvlv_version;
1590     unsigned long   ldvlv_before_count;
1591     unsigned long   ldvlv_after_count;
1592     unsigned long   ldvlv_offset;
1593     unsigned long   ldvlv_count;
1594     struct berval  *ldvlv_attrvalue;
1595     struct berval  *ldvlv_context;
1596     void           *ldvlv_extradata;
1597 } LDAPVLVInfo;
1598
1599 LDAP_F( int )
1600 ldap_create_vlv_control LDAP_P((
1601         LDAP *ld,
1602         LDAPVLVInfo *ldvlistp,
1603         LDAPControl **ctrlp ));
1604
1605 LDAP_F( int )
1606 ldap_parse_vlv_control LDAP_P((
1607         LDAP          *ld,
1608         LDAPControl   **ctrls,
1609         unsigned long *target_posp,
1610         unsigned long *list_countp,
1611         struct berval **contextp,
1612         int           *errcodep ));
1613
1614
1615 LDAP_END_DECL
1616 #endif /* _LDAP_H */