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 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 114
 115 /* OpenLDAP TLS options */
 116 #define LDAP_OPT_X_TLS                          0x6000
 117 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 118 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 119 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 120 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 121 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 122 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 123 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 124 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 125 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 126 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 127
 128 #define LDAP_OPT_X_TLS_NEVER            0
 129 #define LDAP_OPT_X_TLS_HARD             1
 130 #define LDAP_OPT_X_TLS_DEMAND           2
 131 #define LDAP_OPT_X_TLS_ALLOW            3
 132 #define LDAP_OPT_X_TLS_TRY              4
 133
 134 /* OpenLDAP SASL options */
 135 #define LDAP_OPT_X_SASL_MECH                    0x6100
 136 #define LDAP_OPT_X_SASL_REALM                   0x6101
 137 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 138 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 139 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 140 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 141 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 142 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 143 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 144 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 145
 146
 147 /* on/off values */
 148 #define LDAP_OPT_ON             ((void *) 1)
 149 #define LDAP_OPT_OFF    ((void *) 0)
 150
 151 /*
 152  * ldap_get_option() and ldap_set_option() return values.
 153  * As later versions may return other values indicating
 154  * failure, current applications should only compare returned
 155  * value against LDAP_OPT_SUCCESS.
 156  */
 157 #define LDAP_OPT_SUCCESS        0
 158 #define LDAP_OPT_ERROR          (-1)
 159
 160 #define LDAP_API_INFO_VERSION   (1)
 161 typedef struct ldapapiinfo {
 162         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 163         int             ldapai_api_version;                     /* revision of API supported */
 164         int             ldapai_protocol_version;        /* highest LDAP version supported */
 165         char    **ldapai_extensions;            /* names of API extensions */
 166         char    *ldapai_vendor_name;            /* name of supplier */
 167         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 168 } LDAPAPIInfo;
 169
 170 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
 171 typedef struct ldap_apifeature_info {
 172         int             ldapaif_info_version; /* version of this struct (1) */
 173         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
 174         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
 175 } LDAPAPIFeatureInfo;
 176
 177 typedef struct ldapcontrol {
 178         char *                  ldctl_oid;
 179         struct berval   ldctl_value;
 180         char                    ldctl_iscritical;
 181 } LDAPControl;
 182
 183 /* LDAP Controls */
 184
 185 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"
 186 #define LDAP_CONTROL_NOOP                       "1.3.6.1.4.1.4203.1.10.2"
 187
 188 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 189 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 190 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 191 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 192
 193 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
 194
 195 /* LDAP Unsolicited Notifications */
 196 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 197 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 198
 199 /* LDAP Extended Operations */
 200 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
 201
 202 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
 203 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 204 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 205 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 206 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 207
 208 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
 209
 210 /* LDAP Features */
 211 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
 212 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
 213 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 214 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 215 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 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  * structure representing an ldap session which can
 461  * encompass connections to multiple servers (in the
 462  * face of referrals).
 463  */
 464 typedef struct ldap LDAP;
 465
 466 #define LDAP_DEREF_NEVER        0x00
 467 #define LDAP_DEREF_SEARCHING    0x01
 468 #define LDAP_DEREF_FINDING      0x02
 469 #define LDAP_DEREF_ALWAYS       0x03
 470
 471 #define LDAP_NO_LIMIT           0
 472
 473 /* how many messages to retrieve results for */
 474 #define LDAP_MSG_ONE            0x00
 475 #define LDAP_MSG_ALL            0x01
 476 #define LDAP_MSG_RECEIVED       0x02
 477
 478 /*
 479  * types for ldap URL handling
 480  */
 481 typedef struct ldap_url_desc {
 482         struct ldap_url_desc *lud_next;
 483         char    *lud_scheme;
 484         char    *lud_host;
 485         int             lud_port;
 486         char    *lud_dn;
 487         char    **lud_attrs;
 488         int             lud_scope;
 489         char    *lud_filter;
 490         char    **lud_exts;
 491         int             lud_crit_exts;
 492 } LDAPURLDesc;
 493
 494 #define LDAP_URL_SUCCESS                0x00    /* Success */
 495 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 496 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 497
 498 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 499 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 500 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 501 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 502 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 503 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 504 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 505 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 506
 507 /*
 508  * The API draft spec says we should declare (or cause to be declared)
 509  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 510  */
 511 struct timeval;
 512
 513 /*
 514  * in options.c:
 515  */
 516 LDAP_F( int )
 517 ldap_get_option LDAP_P((
 518         LDAP *ld,
 519         int option,
 520         void *outvalue));
 521
 522 LDAP_F( int )
 523 ldap_set_option LDAP_P((
 524         LDAP *ld,
 525         int option,
 526         LDAP_CONST void *invalue));
 527
 528 /* V3 REBIND Function Callback Prototype */
 529 typedef int (LDAP_REBIND_PROC) LDAP_P((
 530         LDAP *ld, LDAP_CONST char *url,
 531         ber_tag_t request, ber_int_t msgid,
 532         void *params ));
 533
 534 LDAP_F( int )
 535 ldap_set_rebind_proc LDAP_P((
 536         LDAP *ld,
 537         LDAP_REBIND_PROC *rebind_proc,
 538         void *params ));
 539
 540 /*
 541  * in controls.c:
 542  */
 543 LDAP_F( int )
 544 ldap_create_control LDAP_P((
 545         LDAP_CONST char *requestOID,
 546         BerElement *ber,
 547         int iscritical,
 548         LDAPControl **ctrlp ));
 549
 550 LDAP_F( void )
 551 ldap_control_free LDAP_P((
 552         LDAPControl *ctrl ));
 553
 554 LDAP_F( void )
 555 ldap_controls_free LDAP_P((
 556         LDAPControl **ctrls ));
 557
 558 /*
 559  * in dnssrv.c:
 560  */
 561 LDAP_F( int )
 562 ldap_domain2dn LDAP_P((
 563         LDAP_CONST char* domain,
 564         char** dn ));
 565
 566 LDAP_F( int )
 567 ldap_dn2domain LDAP_P((
 568         LDAP_CONST char* dn,
 569         char** domain ));
 570
 571 LDAP_F( int )
 572 ldap_domain2hostlist LDAP_P((
 573         LDAP_CONST char *domain,
 574         char** hostlist ));
 575
 576 /*
 577  * in extended.c:
 578  */
 579 LDAP_F( int )
 580 ldap_extended_operation LDAP_P((
 581         LDAP                    *ld,
 582         LDAP_CONST char *reqoid,
 583         struct berval   *reqdata,
 584         LDAPControl             **serverctrls,
 585         LDAPControl             **clientctrls,
 586         int                             *msgidp ));
 587
 588 LDAP_F( int )
 589 ldap_extended_operation_s LDAP_P((
 590         LDAP                    *ld,
 591         LDAP_CONST char *reqoid,
 592         struct berval   *reqdata,
 593         LDAPControl             **serverctrls,
 594         LDAPControl             **clientctrls,
 595         char                    **retoidp,
 596         struct berval   **retdatap ));
 597
 598 LDAP_F( int )
 599 ldap_parse_extended_result LDAP_P((
 600         LDAP                    *ld,
 601         LDAPMessage             *res,
 602         char                    **retoidp,
 603         struct berval   **retdatap,
 604         int                             freeit ));
 605
 606 LDAP_F( int )
 607 ldap_parse_extended_partial LDAP_P((
 608         LDAP                    *ld,
 609         LDAPMessage             *res,
 610         char                    **retoidp,
 611         struct berval   **retdatap,
 612         LDAPControl             ***serverctrls,
 613         int                             freeit ));
 614
 615 /*
 616  * in abandon.c:
 617  */
 618 LDAP_F( int )
 619 ldap_abandon_ext LDAP_P((
 620         LDAP                    *ld,
 621         int                             msgid,
 622         LDAPControl             **serverctrls,
 623         LDAPControl             **clientctrls ));
 624
 625 LDAP_F( int )
 626 ldap_abandon LDAP_P((   /* deprecated */
 627         LDAP *ld,
 628         int msgid ));
 629
 630
 631 /*
 632  * in add.c:
 633  */
 634 LDAP_F( int )
 635 ldap_add_ext LDAP_P((
 636         LDAP                    *ld,
 637         LDAP_CONST char *dn,
 638         LDAPMod                 **attrs,
 639         LDAPControl             **serverctrls,
 640         LDAPControl             **clientctrls,
 641         int                     *msgidp ));
 642
 643 LDAP_F( int )
 644 ldap_add_ext_s LDAP_P((
 645         LDAP                    *ld,
 646         LDAP_CONST char *dn,
 647         LDAPMod                 **attrs,
 648         LDAPControl             **serverctrls,
 649         LDAPControl             **clientctrls ));
 650
 651 LDAP_F( int )
 652 ldap_add LDAP_P((       /* deprecated */
 653         LDAP *ld,
 654         LDAP_CONST char *dn,
 655         LDAPMod **attrs ));
 656
 657 LDAP_F( int )
 658 ldap_add_s LDAP_P((     /* deprecated */
 659         LDAP *ld,
 660         LDAP_CONST char *dn,
 661         LDAPMod **attrs ));
 662
 663
 664 /*
 665  * in sasl.c:
 666  */
 667 LDAP_F( int )
 668 ldap_sasl_bind LDAP_P((
 669         LDAP                    *ld,
 670         LDAP_CONST char *dn,
 671         LDAP_CONST char *mechanism,
 672         struct berval   *cred,
 673         LDAPControl             **serverctrls,
 674         LDAPControl             **clientctrls,
 675         int                             *msgidp ));
 676
 677 /* Interaction flags (should be passed about in a control)
 678  *  Automatic (default): use defaults, prompt otherwise
 679  *  Interactive: prompt always
 680  *  Quiet: never prompt
 681  */
 682 #define LDAP_SASL_AUTOMATIC             0U
 683 #define LDAP_SASL_INTERACTIVE   1U
 684 #define LDAP_SASL_QUIET                 2U
 685
 686 /*
 687  * V3 SASL Interaction Function Callback Prototype
 688  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 689  *  should likely passed in a control (and provided controls)
 690  */
 691 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 692         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 693
 694 LDAP_F( int )
 695 ldap_sasl_interactive_bind_s LDAP_P((
 696         LDAP *ld,
 697         LDAP_CONST char *dn, /* usually NULL */
 698         LDAP_CONST char *saslMechanism,
 699         LDAPControl **serverControls,
 700         LDAPControl **clientControls,
 701
 702         /* should be client controls */
 703         unsigned flags,
 704         LDAP_SASL_INTERACT_PROC *proc,
 705         void *defaults ));
 706
 707 LDAP_F( int )
 708 ldap_sasl_bind_s LDAP_P((
 709         LDAP                    *ld,
 710         LDAP_CONST char *dn,
 711         LDAP_CONST char *mechanism,
 712         struct berval   *cred,
 713         LDAPControl             **serverctrls,
 714         LDAPControl             **clientctrls,
 715         struct berval   **servercredp ));
 716
 717 LDAP_F( int )
 718 ldap_parse_sasl_bind_result LDAP_P((
 719         LDAP                    *ld,
 720         LDAPMessage             *res,
 721         struct berval   **servercredp,
 722         int                             freeit ));
 723
 724 /*
 725  * in bind.c:
 726  *      (deprecated)
 727  */
 728 LDAP_F( int )
 729 ldap_bind LDAP_P((      /* deprecated */
 730         LDAP *ld,
 731         LDAP_CONST char *who,
 732         LDAP_CONST char *passwd,
 733         int authmethod ));
 734
 735 LDAP_F( int )
 736 ldap_bind_s LDAP_P((    /* deprecated */
 737         LDAP *ld,
 738         LDAP_CONST char *who,
 739         LDAP_CONST char *cred,
 740         int authmethod ));
 741
 742 /*
 743  * in sbind.c:
 744  */
 745 LDAP_F( int )
 746 ldap_simple_bind LDAP_P((
 747         LDAP *ld,
 748         LDAP_CONST char *who,
 749         LDAP_CONST char *passwd ));
 750
 751 LDAP_F( int )
 752 ldap_simple_bind_s LDAP_P((
 753         LDAP *ld,
 754         LDAP_CONST char *who,
 755         LDAP_CONST char *passwd ));
 756
 757
 758 /*
 759  * in kbind.c:
 760  *      (deprecated)
 761  */
 762 LDAP_F( int )
 763 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 764         LDAP *ld,
 765         LDAP_CONST char *who ));
 766
 767 LDAP_F( int )
 768 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 769         LDAP *ld,
 770         LDAP_CONST char *who ));
 771
 772 LDAP_F( int )
 773 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 774         LDAP *ld,
 775         LDAP_CONST char *who ));
 776
 777 LDAP_F( int )
 778 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 779         LDAP *ld,
 780         LDAP_CONST char *who ));
 781
 782 LDAP_F( int )
 783 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 784         LDAP *ld,
 785         LDAP_CONST char *who ));
 786
 787 /*
 788  * in cache.c
 789  * (deprecated)
 790  */
 791 LDAP_F( int )
 792 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 793
 794 LDAP_F( void )
 795 ldap_disable_cache LDAP_P(( LDAP *ld ));
 796
 797 LDAP_F( void )
 798 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 799
 800 LDAP_F( void )
 801 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 802
 803 LDAP_F( void )
 804 ldap_flush_cache LDAP_P(( LDAP *ld ));
 805
 806 LDAP_F( void )
 807 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 808
 809 LDAP_F( void )
 810 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 811
 812
 813 /*
 814  * in compare.c:
 815  */
 816 LDAP_F( int )
 817 ldap_compare_ext LDAP_P((
 818         LDAP                    *ld,
 819         LDAP_CONST char *dn,
 820         LDAP_CONST char *attr,
 821         struct berval   *bvalue,
 822         LDAPControl             **serverctrls,
 823         LDAPControl             **clientctrls,
 824         int                     *msgidp ));
 825
 826 LDAP_F( int )
 827 ldap_compare_ext_s LDAP_P((
 828         LDAP                    *ld,
 829         LDAP_CONST char *dn,
 830         LDAP_CONST char *attr,
 831         struct berval   *bvalue,
 832         LDAPControl             **serverctrls,
 833         LDAPControl             **clientctrls ));
 834
 835 LDAP_F( int )
 836 ldap_compare LDAP_P((   /* deprecated */
 837         LDAP *ld,
 838         LDAP_CONST char *dn,
 839         LDAP_CONST char *attr,
 840         LDAP_CONST char *value ));
 841
 842 LDAP_F( int )
 843 ldap_compare_s LDAP_P(( /* deprecated */
 844         LDAP *ld,
 845         LDAP_CONST char *dn,
 846         LDAP_CONST char *attr,
 847         LDAP_CONST char *value ));
 848
 849
 850 /*
 851  * in delete.c:
 852  */
 853 LDAP_F( int )
 854 ldap_delete_ext LDAP_P((
 855         LDAP                    *ld,
 856         LDAP_CONST char *dn,
 857         LDAPControl             **serverctrls,
 858         LDAPControl             **clientctrls,
 859         int                     *msgidp ));
 860
 861 LDAP_F( int )
 862 ldap_delete_ext_s LDAP_P((
 863         LDAP                    *ld,
 864         LDAP_CONST char *dn,
 865         LDAPControl             **serverctrls,
 866         LDAPControl             **clientctrls ));
 867
 868 LDAP_F( int )
 869 ldap_delete LDAP_P((    /* deprecated */
 870         LDAP *ld,
 871         LDAP_CONST char *dn ));
 872
 873 LDAP_F( int )
 874 ldap_delete_s LDAP_P((  /* deprecated */
 875         LDAP *ld,
 876         LDAP_CONST char *dn ));
 877
 878
 879 /*
 880  * in error.c:
 881  */
 882 LDAP_F( int )
 883 ldap_parse_result LDAP_P((
 884         LDAP                    *ld,
 885         LDAPMessage             *res,
 886         int                             *errcodep,
 887         char                    **matcheddnp,
 888         char                    **errmsgp,
 889         char                    ***referralsp,
 890         LDAPControl             ***serverctrls,
 891         int                             freeit ));
 892
 893 LDAP_F( char * )
 894 ldap_err2string LDAP_P((
 895         int err ));
 896
 897 LDAP_F( int )
 898 ldap_result2error LDAP_P((      /* deprecated */
 899         LDAP *ld,
 900         LDAPMessage *r,
 901         int freeit ));
 902
 903 LDAP_F( void )
 904 ldap_perror LDAP_P((    /* deprecated */
 905         LDAP *ld,
 906         LDAP_CONST char *s ));
 907
 908
 909 /*
 910  * in modify.c:
 911  */
 912 LDAP_F( int )
 913 ldap_modify_ext LDAP_P((
 914         LDAP                    *ld,
 915         LDAP_CONST char *dn,
 916         LDAPMod                 **mods,
 917         LDAPControl             **serverctrls,
 918         LDAPControl             **clientctrls,
 919         int                     *msgidp ));
 920
 921 LDAP_F( int )
 922 ldap_modify_ext_s LDAP_P((
 923         LDAP                    *ld,
 924         LDAP_CONST char *dn,
 925         LDAPMod                 **mods,
 926         LDAPControl             **serverctrls,
 927         LDAPControl             **clientctrls ));
 928
 929 LDAP_F( int )
 930 ldap_modify LDAP_P((    /* deprecated */
 931         LDAP *ld,
 932         LDAP_CONST char *dn,
 933         LDAPMod **mods ));
 934
 935 LDAP_F( int )
 936 ldap_modify_s LDAP_P((  /* deprecated */
 937         LDAP *ld,
 938         LDAP_CONST char *dn,
 939         LDAPMod **mods ));
 940
 941
 942 /*
 943  * in modrdn.c:
 944  */
 945 LDAP_F( int )
 946 ldap_rename LDAP_P((
 947         LDAP *ld,
 948         LDAP_CONST char *dn,
 949         LDAP_CONST char *newrdn,
 950         LDAP_CONST char *newSuperior,
 951         int deleteoldrdn,
 952         LDAPControl **sctrls,
 953         LDAPControl **cctrls,
 954         int *msgidp ));
 955
 956 LDAP_F( int )
 957 ldap_rename_s LDAP_P((
 958         LDAP *ld,
 959         LDAP_CONST char *dn,
 960         LDAP_CONST char *newrdn,
 961         LDAP_CONST char *newSuperior,
 962         int deleteoldrdn,
 963         LDAPControl **sctrls,
 964         LDAPControl **cctrls ));
 965
 966 LDAP_F( int )
 967 ldap_rename2 LDAP_P((   /* deprecated */
 968         LDAP *ld,
 969         LDAP_CONST char *dn,
 970         LDAP_CONST char *newrdn,
 971         LDAP_CONST char *newSuperior,
 972         int deleteoldrdn ));
 973
 974 LDAP_F( int )
 975 ldap_rename2_s LDAP_P(( /* deprecated */
 976         LDAP *ld,
 977         LDAP_CONST char *dn,
 978         LDAP_CONST char *newrdn,
 979         LDAP_CONST char *newSuperior,
 980         int deleteoldrdn ));
 981
 982 LDAP_F( int )
 983 ldap_modrdn LDAP_P((    /* deprecated */
 984         LDAP *ld,
 985         LDAP_CONST char *dn,
 986         LDAP_CONST char *newrdn ));
 987
 988 LDAP_F( int )
 989 ldap_modrdn_s LDAP_P((  /* deprecated */
 990         LDAP *ld,
 991         LDAP_CONST char *dn,
 992         LDAP_CONST char *newrdn ));
 993
 994 LDAP_F( int )
 995 ldap_modrdn2 LDAP_P((   /* deprecated */
 996         LDAP *ld,
 997         LDAP_CONST char *dn,
 998         LDAP_CONST char *newrdn,
 999         int deleteoldrdn ));
1000
1001 LDAP_F( int )
1002 ldap_modrdn2_s LDAP_P(( /* deprecated */
1003         LDAP *ld,
1004         LDAP_CONST char *dn,
1005         LDAP_CONST char *newrdn,
1006         int deleteoldrdn));
1007
1008
1009 /*
1010  * in open.c:
1011  */
1012 LDAP_F( LDAP * )
1013 ldap_init LDAP_P((
1014         LDAP_CONST char *host,
1015         int port ));
1016
1017 LDAP_F( LDAP * )
1018 ldap_open LDAP_P((      /* deprecated */
1019         LDAP_CONST char *host,
1020         int port ));
1021
1022 LDAP_F( int )
1023 ldap_create LDAP_P((
1024         LDAP **ldp ));
1025
1026 LDAP_F( int )
1027 ldap_initialize LDAP_P((
1028         LDAP **ldp,
1029         LDAP_CONST char *url ));
1030
1031 LDAP_F( int )
1032 ldap_start_tls_s LDAP_P((
1033         LDAP *ld,
1034         LDAPControl **serverctrls,
1035         LDAPControl **clientctrls ));
1036
1037 /*
1038  * in messages.c:
1039  */
1040 LDAP_F( LDAPMessage * )
1041 ldap_first_message LDAP_P((
1042         LDAP *ld,
1043         LDAPMessage *chain ));
1044
1045 LDAP_F( LDAPMessage * )
1046 ldap_next_message LDAP_P((
1047         LDAP *ld,
1048         LDAPMessage *msg ));
1049
1050 LDAP_F( int )
1051 ldap_count_messages LDAP_P((
1052         LDAP *ld,
1053         LDAPMessage *chain ));
1054
1055
1056 /*
1057  * in references.c:
1058  */
1059 LDAP_F( LDAPMessage * )
1060 ldap_first_reference LDAP_P((
1061         LDAP *ld,
1062         LDAPMessage *chain ));
1063
1064 LDAP_F( LDAPMessage * )
1065 ldap_next_reference LDAP_P((
1066         LDAP *ld,
1067         LDAPMessage *ref ));
1068
1069 LDAP_F( int )
1070 ldap_count_references LDAP_P((
1071         LDAP *ld,
1072         LDAPMessage *chain ));
1073
1074 LDAP_F( int )
1075 ldap_parse_reference LDAP_P((
1076         LDAP                    *ld,
1077         LDAPMessage             *ref,
1078         char                    ***referralsp,
1079         LDAPControl             ***serverctrls,
1080         int                             freeit));
1081
1082
1083 /*
1084  * in getentry.c:
1085  */
1086 LDAP_F( LDAPMessage * )
1087 ldap_first_entry LDAP_P((
1088         LDAP *ld,
1089         LDAPMessage *chain ));
1090
1091 LDAP_F( LDAPMessage * )
1092 ldap_next_entry LDAP_P((
1093         LDAP *ld,
1094         LDAPMessage *entry ));
1095
1096 LDAP_F( int )
1097 ldap_count_entries LDAP_P((
1098         LDAP *ld,
1099         LDAPMessage *chain ));
1100
1101 LDAP_F( int )
1102 ldap_get_entry_controls LDAP_P((
1103         LDAP                    *ld,
1104         LDAPMessage             *entry,
1105         LDAPControl             ***serverctrls));
1106
1107
1108 /*
1109  * in addentry.c
1110  */
1111 LDAP_F( LDAPMessage * )
1112 ldap_delete_result_entry LDAP_P((
1113         LDAPMessage **list,
1114         LDAPMessage *e ));
1115
1116 LDAP_F( void )
1117 ldap_add_result_entry LDAP_P((
1118         LDAPMessage **list,
1119         LDAPMessage *e ));
1120
1121
1122 /*
1123  * in getdn.c
1124  */
1125 LDAP_F( char * )
1126 ldap_get_dn LDAP_P((
1127         LDAP *ld,
1128         LDAPMessage *entry ));
1129
1130 typedef struct ldap_ava {
1131         struct berval la_attr;
1132         struct berval la_value;
1133         unsigned la_flags;
1134 #define LDAP_AVA_STRING         0x0000U
1135 #define LDAP_AVA_BINARY         0x0001U
1136 #define LDAP_AVA_NONPRINTABLE   0x0002U
1137
1138         void *la_private;
1139 } LDAPAVA;
1140
1141 typedef LDAPAVA** LDAPRDN;
1142 typedef LDAPRDN** LDAPDN;
1143
1144 /* DN formats */
1145 #define LDAP_DN_FORMAT_LDAP             0x0000U
1146 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1147 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1148 #define LDAP_DN_FORMAT_DCE              0x0030U
1149 #define LDAP_DN_FORMAT_UFN              0x0040U /* dn2str only */
1150 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1151 #define LDAP_DN_FORMAT_LBER             0x00F0U /* for testing only */
1152 #define LDAP_DN_FORMAT_MASK             0x00F0U
1153
1154 /* DN flags */
1155 #define LDAP_DN_PRETTY                  0x0100U
1156 #define LDAP_DN_SKIP                    0x0200U
1157 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1158 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1159 #define LDAP_DN_PEDANTIC                0xF000U
1160
1161 LDAP_F( void )
1162 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1163 LDAP_F( void )
1164 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1165 LDAP_F( void )
1166 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1167
1168 LDAP_F( int )
1169 ldap_bv2dn LDAP_P((
1170         struct berval *bv,
1171         LDAPDN **dn,
1172         unsigned flags ));
1173
1174 LDAP_F( int )
1175 ldap_str2dn LDAP_P((
1176         LDAP_CONST char *str,
1177         LDAPDN **dn,
1178         unsigned flags ));
1179
1180 LDAP_F( int )
1181 ldap_dn2bv LDAP_P((
1182         LDAPDN *dn,
1183         struct berval *bv,
1184         unsigned flags ));
1185
1186 LDAP_F( int )
1187 ldap_dn2str LDAP_P((
1188         LDAPDN *dn,
1189         char **str,
1190         unsigned flags ));
1191
1192 LDAP_F( int )
1193 ldap_bv2rdn LDAP_P((
1194         struct berval *bv,
1195         LDAPRDN **rdn,
1196         char **next,
1197         unsigned flags ));
1198
1199 LDAP_F( int )
1200 ldap_str2rdn LDAP_P((
1201         LDAP_CONST char *str,
1202         LDAPRDN **rdn,
1203         char **next,
1204         unsigned flags ));
1205
1206 LDAP_F( int )
1207 ldap_rdn2bv LDAP_P((
1208         LDAPRDN *rdn,
1209         struct berval *bv,
1210         unsigned flags ));
1211
1212 LDAP_F( int )
1213 ldap_rdn2str LDAP_P((
1214         LDAPRDN *rdn,
1215         char **str,
1216         unsigned flags ));
1217
1218 LDAP_F( int )
1219 ldap_dn_normalize LDAP_P((
1220         LDAP_CONST char *in, unsigned iflags,
1221         char **out, unsigned oflags ));
1222
1223 LDAP_F( char * )
1224 ldap_dn2ufn LDAP_P(( /* deprecated */
1225         LDAP_CONST char *dn ));
1226
1227 LDAP_F( char ** )
1228 ldap_explode_dn LDAP_P(( /* deprecated */
1229         LDAP_CONST char *dn,
1230         int notypes ));
1231
1232 LDAP_F( char ** )
1233 ldap_explode_rdn LDAP_P(( /* deprecated */
1234         LDAP_CONST char *rdn,
1235         int notypes ));
1236
1237 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1238
1239 LDAP_F( int )
1240 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1241         LDAPDN_rewrite_func *func, unsigned flags ));
1242
1243 LDAP_F( char * )
1244 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1245
1246 LDAP_F( char * )
1247 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1248
1249 LDAP_F( char * )
1250 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1251
1252 LDAP_F( int )
1253 ldap_get_dn_ber LDAP_P((
1254         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1255
1256 LDAP_F( int )
1257 ldap_get_attribute_ber LDAP_P((
1258         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1259         struct berval **vals ));
1260
1261 /*
1262  * in getattr.c
1263  */
1264 LDAP_F( char * )
1265 ldap_first_attribute LDAP_P((
1266         LDAP *ld,
1267         LDAPMessage *entry,
1268         BerElement **ber ));
1269
1270 LDAP_F( char * )
1271 ldap_next_attribute LDAP_P((
1272         LDAP *ld,
1273         LDAPMessage *entry,
1274         BerElement *ber ));
1275
1276
1277 /*
1278  * in getvalues.c
1279  */
1280 LDAP_F( struct berval ** )
1281 ldap_get_values_len LDAP_P((
1282         LDAP *ld,
1283         LDAPMessage *entry,
1284         LDAP_CONST char *target ));
1285
1286 LDAP_F( int )
1287 ldap_count_values_len LDAP_P((
1288         struct berval **vals ));
1289
1290 LDAP_F( void )
1291 ldap_value_free_len LDAP_P((
1292         struct berval **vals ));
1293
1294 LDAP_F( char ** )
1295 ldap_get_values LDAP_P((        /* deprecated */
1296         LDAP *ld,
1297         LDAPMessage *entry,
1298         LDAP_CONST char *target ));
1299
1300 LDAP_F( int )
1301 ldap_count_values LDAP_P((      /* deprecated */
1302         char **vals ));
1303
1304 LDAP_F( void )
1305 ldap_value_free LDAP_P((        /* deprecated */
1306         char **vals ));
1307
1308 /*
1309  * in result.c:
1310  */
1311 LDAP_F( int )
1312 ldap_result LDAP_P((
1313         LDAP *ld,
1314         int msgid,
1315         int all,
1316         struct timeval *timeout,
1317         LDAPMessage **result ));
1318
1319 LDAP_F( int )
1320 ldap_msgtype LDAP_P((
1321         LDAPMessage *lm ));
1322
1323 LDAP_F( int )
1324 ldap_msgid   LDAP_P((
1325         LDAPMessage *lm ));
1326
1327 LDAP_F( int )
1328 ldap_msgfree LDAP_P((
1329         LDAPMessage *lm ));
1330
1331 LDAP_F( int )
1332 ldap_msgdelete LDAP_P((
1333         LDAP *ld,
1334         int msgid ));
1335
1336
1337 /*
1338  * in search.c:
1339  */
1340 LDAP_F( int )
1341 ldap_search_ext LDAP_P((
1342         LDAP                    *ld,
1343         LDAP_CONST char *base,
1344         int                             scope,
1345         LDAP_CONST char *filter,
1346         char                    **attrs,
1347         int                             attrsonly,
1348         LDAPControl             **serverctrls,
1349         LDAPControl             **clientctrls,
1350         struct timeval  *timeout,
1351         int                             sizelimit,
1352         int                             *msgidp ));
1353
1354 LDAP_F( int )
1355 ldap_search_ext_s LDAP_P((
1356         LDAP                    *ld,
1357         LDAP_CONST char *base,
1358         int                             scope,
1359         LDAP_CONST char *filter,
1360         char                    **attrs,
1361         int                             attrsonly,
1362         LDAPControl             **serverctrls,
1363         LDAPControl             **clientctrls,
1364         struct timeval  *timeout,
1365         int                             sizelimit,
1366         LDAPMessage             **res ));
1367
1368 LDAP_F( int )
1369 ldap_search LDAP_P((    /* deprecated */
1370         LDAP *ld,
1371         LDAP_CONST char *base,
1372         int scope,
1373         LDAP_CONST char *filter,
1374         char **attrs,
1375         int attrsonly ));
1376
1377 LDAP_F( int )
1378 ldap_search_s LDAP_P((  /* deprecated */
1379         LDAP *ld,
1380         LDAP_CONST char *base,
1381         int scope,
1382         LDAP_CONST char *filter,
1383         char **attrs,
1384         int attrsonly,
1385         LDAPMessage **res ));
1386
1387 LDAP_F( int )
1388 ldap_search_st LDAP_P(( /* deprecated */
1389         LDAP *ld,
1390         LDAP_CONST char *base,
1391         int scope,
1392         LDAP_CONST char *filter,
1393     char **attrs,
1394         int attrsonly,
1395         struct timeval *timeout,
1396         LDAPMessage **res ));
1397
1398 /*
1399  * in unbind.c
1400  */
1401 LDAP_F( int )
1402 ldap_unbind LDAP_P(( /* deprecated */
1403         LDAP *ld ));
1404
1405 LDAP_F( int )
1406 ldap_unbind_s LDAP_P(( /* deprecated */
1407         LDAP *ld ));
1408
1409 LDAP_F( int )
1410 ldap_unbind_ext LDAP_P((
1411         LDAP                    *ld,
1412         LDAPControl             **serverctrls,
1413         LDAPControl             **clientctrls));
1414
1415 LDAP_F( int )
1416 ldap_unbind_ext_s LDAP_P((
1417         LDAP                    *ld,
1418         LDAPControl             **serverctrls,
1419         LDAPControl             **clientctrls));
1420
1421 /*
1422  * in filter.c
1423  */
1424 LDAP_F( int )
1425 ldap_put_vrFilter LDAP_P((
1426         BerElement *ber,
1427         const char *vrf ));
1428
1429 /*
1430  * in free.c
1431  */
1432
1433 LDAP_F( void * )
1434 ldap_memalloc LDAP_P((
1435         ber_len_t s ));
1436
1437 LDAP_F( void * )
1438 ldap_memrealloc LDAP_P((
1439         void* p,
1440         ber_len_t s ));
1441
1442 LDAP_F( void * )
1443 ldap_memcalloc LDAP_P((
1444         ber_len_t n,
1445         ber_len_t s ));
1446
1447 LDAP_F( void )
1448 ldap_memfree LDAP_P((
1449         void* p ));
1450
1451 LDAP_F( void )
1452 ldap_memvfree LDAP_P((
1453         void** v ));
1454
1455 LDAP_F( char * )
1456 ldap_strdup LDAP_P((
1457         LDAP_CONST char * ));
1458
1459 LDAP_F( void )
1460 ldap_mods_free LDAP_P((
1461         LDAPMod **mods,
1462         int freemods ));
1463
1464
1465 /*
1466  * in sort.c
1467  *      (deprecated)
1468  */
1469 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1470         LDAP_CONST char *left,
1471         LDAP_CONST char *right ));
1472
1473 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1474         LDAP_CONST void *left,
1475         LDAP_CONST void *right ));
1476
1477 LDAP_F( int )   /* deprecated */
1478 ldap_sort_entries LDAP_P(( LDAP *ld,
1479         LDAPMessage **chain,
1480         LDAP_CONST char *attr,
1481         LDAP_SORT_AD_CMP_PROC *cmp ));
1482
1483 LDAP_F( int )   /* deprecated */
1484 ldap_sort_values LDAP_P((
1485         LDAP *ld,
1486         char **vals,
1487         LDAP_SORT_AV_CMP_PROC *cmp ));
1488
1489 LDAP_F( int ) /* deprecated */
1490 ldap_sort_strcasecmp LDAP_P((
1491         LDAP_CONST void *a,
1492         LDAP_CONST void *b ));
1493
1494
1495 /*
1496  * in url.c
1497  */
1498 LDAP_F( int )
1499 ldap_is_ldap_url LDAP_P((
1500         LDAP_CONST char *url ));
1501
1502 LDAP_F( int )
1503 ldap_is_ldaps_url LDAP_P((
1504         LDAP_CONST char *url ));
1505
1506 LDAP_F( int )
1507 ldap_is_ldapi_url LDAP_P((
1508         LDAP_CONST char *url ));
1509
1510 LDAP_F( int )
1511 ldap_url_parse LDAP_P((
1512         LDAP_CONST char *url,
1513         LDAPURLDesc **ludpp ));
1514
1515 LDAP_F( char * )
1516 ldap_url_desc2str LDAP_P((
1517         LDAPURLDesc *ludp ));
1518
1519 LDAP_F( void )
1520 ldap_free_urldesc LDAP_P((
1521         LDAPURLDesc *ludp ));
1522
1523 /*
1524  * in sortctrl.c
1525  */
1526 /*
1527  * structure for a sort-key
1528  */
1529 typedef struct ldapsortkey {
1530         char *  attributeType;
1531         char *  orderingRule;
1532         int     reverseOrder;
1533 } LDAPSortKey;
1534
1535 LDAP_F( int )
1536 ldap_create_sort_keylist LDAP_P((
1537         LDAPSortKey ***sortKeyList,
1538         char        *keyString ));
1539
1540 LDAP_F( void )
1541 ldap_free_sort_keylist LDAP_P((
1542         LDAPSortKey **sortkeylist ));
1543
1544 LDAP_F( int )
1545 ldap_create_sort_control LDAP_P((
1546         LDAP *ld,
1547         LDAPSortKey **keyList,
1548         int ctl_iscritical,
1549         LDAPControl **ctrlp ));
1550
1551 LDAP_F( int )
1552 ldap_parse_sort_control LDAP_P((
1553         LDAP           *ld,
1554         LDAPControl    **ctrlp,
1555         unsigned long  *result,
1556         char           **attribute ));
1557
1558
1559 /*
1560  * in vlvctrl.c
1561  */
1562
1563 /*
1564  * structure for virtual list.
1565  */
1566 typedef struct ldapvlvinfo {
1567         int             ldvlv_version;
1568     unsigned long   ldvlv_before_count;
1569     unsigned long   ldvlv_after_count;
1570     unsigned long   ldvlv_offset;
1571     unsigned long   ldvlv_count;
1572     struct berval  *ldvlv_attrvalue;
1573     struct berval  *ldvlv_context;
1574     void           *ldvlv_extradata;
1575 } LDAPVLVInfo;
1576
1577 LDAP_F( int )
1578 ldap_create_vlv_control LDAP_P((
1579         LDAP *ld,
1580         LDAPVLVInfo *ldvlistp,
1581         LDAPControl **ctrlp ));
1582
1583 LDAP_F( int )
1584 ldap_parse_vlv_control LDAP_P((
1585         LDAP          *ld,
1586         LDAPControl   **ctrls,
1587         unsigned long *target_posp,
1588         unsigned long *list_countp,
1589         struct berval **contextp,
1590         int           *errcodep ));
1591
1592
1593 LDAP_END_DECL
1594 #endif /* _LDAP_H */