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