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

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