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